Update docs when generating new Datasource #5624
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
documentation
blackboxsw
added a commit
to blackboxsw/cloud-init
that referenced
this pull request
Aug 15, 2024
blackboxsw
force-pushed
the
docs-new-ds
branch
from
2d65312 to
1311a87
Compare
blackboxsw
added a commit
to blackboxsw/cloud-init
that referenced
this pull request
Aug 15, 2024
a-dubs
approved these changes
Aug 16, 2024
| 1. Add a new file in :file:`doc/rtd/reference/datasources/<cloudplatform>.rst` | ||
| 2. Reference `<cloudplatform>.rst` in :file:`doc/rtd/reference/datasources.rst` | ||
| 3. Add an alphebetized dsname entry in representing your datasource | ||
| :file:`doc/rtd/reference/datasource_dsname_map.rst` |
There was a problem hiding this comment.
should there be a more direct call to action here to use the command found in doc/rtd/reference/datasource_dsname_map.rst to generate the datasource list? Or is it just easier to tell the user to simply insert their new DS name in the list alphabetically (like you currently have)?
There was a problem hiding this comment.
It shouldn't need to be regenerated each time, so I think the instructions here make the most sense.
blackboxsw
force-pushed
the
docs-new-ds
branch
from
1311a87 to
cfaf229
Compare
blackboxsw
added a commit
that referenced
this pull request
Aug 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Minor updates to docs to tell DS creators they need to add dsname entries to datasource_dsname_map.rst
Proposed Commit Message
See individual commits
Additional Context
Test Steps
Merge type