Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define Knack App Readme Template #14

Closed
johnclary opened this issue Apr 12, 2019 · 2 comments
Closed

Define Knack App Readme Template #14

johnclary opened this issue Apr 12, 2019 · 2 comments
Labels
Impact: 3-Minor Deteriorates TPW service delivery Service: Apps Application support Type: Other Not covered by other issue types Workgroup: DTS Data and Technology Services

Comments

@johnclary
Copy link
Member

johnclary commented Apr 12, 2019

All knack app repositories should have a readme that follows the same structure.

Proposing:

# App Name
<description>

#### Login
<login url>

#### Stakholder Divisions
- <stakeholder 1>
- <stakeholder 2>

**[Read the docs](<documentation url>)**

![screenshot](screenshot.png)

For example:
https://github.com/cityofaustin/transportation-data-tracker/blob/master/README.md

@johnclary johnclary changed the title Define Knack App Readme Structure Define Knack App Readme Template Apr 12, 2019
@johnclary johnclary added Impact: 3-Minor Deteriorates TPW service delivery Service: Apps Application support Type: Other Not covered by other issue types Workgroup: DTS Data and Technology Services labels Apr 25, 2019
@johnclary
Copy link
Member Author

@amenity @dianamartin any feedback? can we close this out?

@dianamartin
Copy link
Contributor

@johnclary @amenity It like this and have already followed the template. Let's close this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Impact: 3-Minor Deteriorates TPW service delivery Service: Apps Application support Type: Other Not covered by other issue types Workgroup: DTS Data and Technology Services
Projects
None yet
Development

No branches or pull requests

3 participants