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: convert all rst to md #80

Merged
merged 3 commits into from
Jun 26, 2023
Merged

docs: convert all rst to md #80

merged 3 commits into from
Jun 26, 2023

Conversation

marquiz
Copy link
Collaborator

@marquiz marquiz commented Jun 22, 2023

Convert all reStructuredText files into markdown to have all the documentation in the same format.

Depends on #78 and #79

Drop one level of sub-hierarchy, making "Policies" a top-level item in
the "Resource Policy Plugins" section. Makes the documentation easier to
follow (and easier to find the detailed docs of the actual
policies/plugins).

Signed-off-by: Markus Lehtonen <[email protected]>
Edit the text at some parts describing the dynamic configuration,
replacing "agent" with "dynamic configuration", trying to make it easier
to read for the casual reader (who doesn't really care about the
internal architecture, involving "agent").

Also, rename "resource-policy/node-agent.md" to "configuration.md" which
better matches with the heading and contents.

Signed-off-by: Markus Lehtonen <[email protected]>
@klihub
Copy link
Collaborator

klihub commented Jun 22, 2023

This is really nice. We only had a few rst's and it's good to get everything to a single format if possible.

Convert all reStructuredText files into markdown to have all the
documentation in the same format.

Signed-off-by: Markus Lehtonen <[email protected]>
@jukkar jukkar merged commit 1212598 into containers:main Jun 26, 2023
@marquiz marquiz deleted the devel/docs branch October 11, 2023 11:11
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.

3 participants