Docs: Exemplar package documentation

• Pick a package to serve as an exemplar (ArgoCD)
• Integrate with Hugo
• Document end to end
• Test links and rendering to make sure they all work

added to epic &24 (closed)

changed title from Docs: Examplar package documentation to Docs: Exemplar package documentation

changed the description

Exemplar repos: ArgoCD and ClusterAuditor. Branch with current work: docs-robk

changed the description

assigned to @aaronbeger

assigned to @jdale

unassigned @aaronbeger

added BB Documentation Standards kinddocs labels

changed the description

marked the checklist item Pick a package to serve as an exemplar (ArgoCD) as completed

spinning up BB with the a branch that has the documentation work - first goal is to make it all work then move on to setting a template/standard for other package owners to follow.

BB cluster is running on the branch 'docs-robk'. The hugo site is rendering correctly at 'docs.bigbang.dev' (its only accessible from the cluster) and serving pages for argocd. However the pages are blank for now until getting the hugo format down.

Next task - add files in argocd's docs directory that hugo is expecting so the pages render.

marked the checklist item Integrate with Hugo as completed

See screen shot above, one thing to note is that when the 'cluster auditor' service was set to 'enabled: true' the doc container did not work - but only the cluster auditor container was having issues.

marked the checklist item Document end to end as completed

marked the checklist item Test links and rendering to make sure they all work as completed

@kenna81 @rkernick can https://repo1.dso.mil/platform-one/big-bang/bigbang/-/issues/201 be closed?

added teamXForce label

added stale label

Closed due to inactivity and 4/4 tasks complete.

closed

removed stale label

mentioned in merge request big-bang/product/packages/elasticsearch-kibana!289 (merged)