Update README based on go template from gluon
Utilize the norwoodj/helm-docs
image from docker (more info) and the go template in gluon/docs to generate a new README for the authservice package. Follow instructions in the Gluon Document https://repo1.dso.mil/platform-one/big-bang/apps/library-charts/gluon/-/blob/master/docs/bb-package-readme.md .
AC:
- README Renders correctly
- Links are correct
- Information is correct
Designs
- Show closed items
Activity
-
Newest first Oldest first
-
Show all activity Show comments only Show history only
- Ryan Garcia added Big Bang Add-Ons mattermost labels
added Big Bang Add-Ons mattermost labels
- Ryan Garcia changed the description
Compare with previous version changed the description
- Ryan Garcia added kinddocs teamXForce labels
added kinddocs teamXForce labels
- Ryan Garcia set weight to 1
set weight to 1
- Ryan Garcia added priority5 label
added priority5 label
- Ryan Garcia changed milestone to %1.21.0
changed milestone to %1.21.0
- Ryan Garcia changed iteration to Big Bang Iterations Nov 2, 2021 - Nov 15, 2021
changed iteration to Big Bang Iterations Nov 2, 2021 - Nov 15, 2021
- Quentin Powell assigned to @trkdashin
assigned to @trkdashin
- Quentin Powell created merge request !73 (merged) to address this issue
created merge request !73 (merged) to address this issue
- Quentin Powell mentioned in merge request !73 (merged)
mentioned in merge request !73 (merged)
- Quentin Powell added statusdoing label
added statusdoing label
- Quentin Powell marked the checklist item README Renders correctly as completed
marked the checklist item README Renders correctly as completed
- Quentin Powell marked the checklist item Information is correct as completed
marked the checklist item Information is correct as completed
- Contributor
@ryan.j.garcia When testing the
Application Overview
link I noticed that there is nooverview.md
document in the docs folder. The link takes you to the README (same page you're already on). Is this ok? If not, what action should I take? All other links work. And all other things are good Collapse replies - Author Contributor
@trkdashin Can you populate a
docs/overview.md
? Here are a few examples, they are just general overviews of compiled info from around the greater internet.https://repo1.dso.mil/platform-one/big-bang/apps/core/fluentbit/-/blob/main/docs/overview.md
https://repo1.dso.mil/platform-one/big-bang/apps/core/authservice/-/blob/main/docs/overview.md
Edited by Ryan Garcia - Contributor
@ryan.j.garcia have a look at the Mattermost overview.md file.
Once you give me a thumbs up or provide feedback I'll move this one on along.
- Author Contributor
Thanks @trkdashin left a comment on the MR. Looks good after that suggestion is applied, or at least something similar.
- Micah Nagel mentioned in merge request !71 (merged)
mentioned in merge request !71 (merged)
- Quentin Powell marked the checklist item Links are correct as completed
marked the checklist item Links are correct as completed
- Quentin Powell added statusreview label and removed statusdoing label
added statusreview label and removed statusdoing label
- Contributor
Dropped a comment on the MR - we will need to get the conflicts resolved and version updated.
- Micah Nagel added statusdoing label and removed statusreview label
added statusdoing label and removed statusreview label
- Quentin Powell marked the checklist item README Renders correctly as incomplete
marked the checklist item README Renders correctly as incomplete
- Quentin Powell marked the checklist item README Renders correctly as completed
marked the checklist item README Renders correctly as completed
- Quentin Powell added statusreview label and removed statusdoing label
added statusreview label and removed statusdoing label
- Micah Nagel closed with commit eea8849b
closed with commit eea8849b
- Micah Nagel mentioned in commit eea8849b
mentioned in commit eea8849b
- bigbang bot removed statusreview label
removed statusreview label