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

Update internal docs #417

Open
tjtelan opened this issue Oct 25, 2022 · 1 comment
Open

Update internal docs #417

tjtelan opened this issue Oct 25, 2022 · 1 comment

Comments

@tjtelan
Copy link
Contributor

tjtelan commented Oct 25, 2022

README.md needs instructions for

  • fork-pull model
  • merge with bors
    • Procedures for how to skip checks for merge (TBD)

WRITERS.md needs some words about the structure of the docs.

  • Where to add things so they can adhere to the documentation structure
  • How to write internal links so they get checked by Hugo at compile
  • Examples of shortcodes we have installed
  • Code-block strategy, and what goes in them vs what goes inside the content
@tjtelan
Copy link
Contributor Author

tjtelan commented Dec 6, 2022

For README.md, I added a diagram to document the gitops workflow, but in order for it to be more useful, we need to add automation that will render and commit it into the repo when it gets updated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant