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

Documentation needs clarification. #11

Open
6 tasks
adammccartney opened this issue Dec 29, 2022 · 1 comment
Open
6 tasks

Documentation needs clarification. #11

adammccartney opened this issue Dec 29, 2022 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@adammccartney
Copy link
Contributor

This essentially involves updates to the readme.

  • Clarify ingress exercise: currently an ingress is created as part of the first deployment, then excluded from helm. Is this correct?
  • Clarify ingress exercise: there is a reference to a tutorial/ingress branch in the readme, can we remove this and just have the content in the main branch?
  • Clarify rbac exercise. There is currently a commented out security/rbac section. Should this be included in the readme?
  • Clarify section on helm: the repo includes an example of a helm chart. The readme refers to writing your own chart, again by way of branching: tutorial/helm. This branch is currently non-existent. Does it need to be recreated, if so, how?
  • Clarify section on helm: do we really need the section on hosting your own webserver to serve your chart?
  • Reposition section on architecture (should be at top of readme)
@adammccartney adammccartney added the documentation Improvements or additions to documentation label Dec 29, 2022
@adammccartney adammccartney self-assigned this Dec 29, 2022
@adammccartney adammccartney added this to the v0.0.5 milestone Dec 29, 2022
@adammccartney
Copy link
Contributor Author

@entlein here's a rough outline of what we discussed yesterday. There are a couple of points that need to be clarified, particularly those relating to the branching workflow.

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

No branches or pull requests

1 participant