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: flatten the hierarchy #78

Closed
wants to merge 1 commit into from

Conversation

marquiz
Copy link
Collaborator

@marquiz marquiz commented Jun 22, 2023

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).

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]>
Copy link
Collaborator

@klihub klihub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure which one is better, so I'm fine with this.

@marquiz
Copy link
Collaborator Author

marquiz commented Jun 22, 2023

I just find the current very deep hierarchy really odd and cumbersome

Resource Policy Plugins -> Configuration -> Policy -> Topology-Aware

Especially when it's not just about configuration of the policy but a detailed documentation of all aspects of the policy

@jukkar
Copy link
Collaborator

jukkar commented Jun 26, 2023

Already merged

@jukkar jukkar closed this Jun 26, 2023
@klihub
Copy link
Collaborator

klihub commented Jun 26, 2023

Merged as part of stacked PR #80.

@marquiz marquiz deleted the devel/docs-hierarchy 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