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

[docs] WIP - cloud config examples library #5282

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

s-makin
Copy link
Contributor

@s-makin s-makin commented May 11, 2024

Proposed Commit Message

docs: Create cloud-config examples library

We currently have examples scattered across the docs, making
them hard to find/use.

This PR gathers them together, organising by operation rather
than by module.

- Add landing page
- Add explanation of #cloud-config yaml file
- Add a page for each example (similar modules grouped)
- Pages are grouped by similar operations

Additional Context

  • Original examples all remain in their original locations while we iterate
  • Intend to link this into the upcoming changes to module docs

Merge type

  • Squash merge using "Proposed Commit Message"
  • Rebase and merge unique commits. Requires commit messages per-commit each referencing the pull request number (#<PR_NUM>)

- Broke up current examples (single) page
- Extracted examples from modules page
- Extracted examples from examples folder
- Added landing page for examples library
- Added explanation of cloud-config file
@s-makin s-makin marked this pull request as draft May 15, 2024 14:26
@blackboxsw blackboxsw self-assigned this May 29, 2024
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.

None yet

2 participants