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

controller guide intro + object clarification #9

Merged
merged 7 commits into from
Mar 7, 2022
Merged

controller guide intro + object clarification #9

merged 7 commits into from
Mar 7, 2022

Conversation

clux
Copy link
Member

@clux clux commented Feb 28, 2022

an introductory that uses roughly the proposed outline in #5

contains a few verification TODOs that feel off in kube, and needs some more docs to cross link from.

also changing the layout a bit. making folders show up as tabs in the nav bar:

Screenshot from 2022-02-28 09-18-45

@clux
Copy link
Member Author

clux commented Feb 28, 2022

I'll undoubtedly run into cases where things seem less than optimal (as usually happens when writing guides). I'll lift the TODOs into a meta issue on the main repo so we can discuss things that possibly needs a little polishing.

- adds first mermaid diagram - closes #10
- adds tables
- adds a file for common links
- adds a file for common abbreviations

and also starts writing the doc for the common objects

Signed-off-by: clux <[email protected]>
@clux clux linked an issue Mar 2, 2022 that may be closed by this pull request
@clux
Copy link
Member Author

clux commented Mar 3, 2022

ok, first two sections are kind of done. will likely rewrite these some more as we go along, but will try to merge this at some point tomorrow after lifting out the TODOs (but will probably leave it more or less as is).

@clux clux changed the title controller guide intro - for #5 controller guide intro + object clarification Mar 5, 2022
@clux clux mentioned this pull request Mar 5, 2022
19 tasks
@clux
Copy link
Member Author

clux commented Mar 7, 2022

going to merge this now as i've made tons of changes to the organisation and versions of mkdocs to make this all nice.
it includes 2 completed chapters (intro + object), so feel free to drop any feedback on it, but will otherwise try to carry on by writing about how to write the application later.

@clux clux merged commit 30c5169 into main Mar 7, 2022
@clux clux deleted the ctrl branch March 7, 2022 09:37
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

Successfully merging this pull request may close these issues.

enable mermaid diagrams
1 participant