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.

Sign up for GitHub

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

Jump to bottom

Add Documentation #10

Closed
Tracked by #69
PatAKnight opened this issue Jan 31, 2023 · 1 comment · Fixed by #110
Closed
Tracked by #69

Add Documentation #10

PatAKnight opened this issue Jan 31, 2023 · 1 comment · Fixed by #110
Assignees
@PatAKnight
Labels
kind/documentation priority/medium

Comments

@PatAKnight
Copy link
Member

Story

  • As a developer, I would like to better understand the purpose of the Backstage Showcase app.

Description

  • We should expanded up our documentation to allow members of the community to better understand the Backstage Showcase app. This should include information on contributing to the project (creating issues, pull requests), an updated README (outlining the purpose of the app and links to additional documentation), how to get started with the app, and more.

AC

  • Updated README to explain the purpose of the app
  • Contribution documentation

Additional Notes

  • This will need more refinement to better capture what all we will be looking for.
@rtaniwa rtaniwa mentioned this issue Feb 13, 2023
Closed
14 tasks
@PatAKnight PatAKnight self-assigned this Mar 9, 2023
@christophe-f
Copy link
Contributor

With the documentation available in the README, is it good to close?

@PatAKnight PatAKnight mentioned this issue Mar 13, 2023
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@PatAKnight PatAKnight

Labels
kind/documentation priority/medium
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add more to README PatAKnight/backstage-showcase
2 participants
@christophe-f @PatAKnight