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: restructure and streamline documentation #1003

Merged
merged 2 commits into from
Oct 5, 2023

Conversation

kayman-mk
Copy link
Collaborator

Description

This PR restructures the whole documentation and adapts it to the changed variable names introduces with v7 release.

  • shorten the main document
  • underline that contributions are welcome
  • create a pitfall document
  • moving the detailed concepts into a separate file

@kayman-mk kayman-mk requested a review from npalm as a code owner October 5, 2023 09:40
@github-actions
Copy link
Contributor

github-actions bot commented Oct 5, 2023

Hey @kayman-mk! 👋

Thank you for your contribution to the project. Please refer to the contribution rules for a quick overview of the process.

Make sure that this PR clearly explains:

  • the problem being solved
  • the best way a reviewer and you can test your changes

With submitting this PR you confirm that you hold the rights of the code added and agree that it will published under this LICENSE.

The following ChatOps commands are supported:

  • /help: notifies a maintainer to help you out

Simply add a comment with the command in the first line. If you need to pass more information, separate it with a blank line from the command.

This message was generated automatically. You are welcome to improve it.

@kayman-mk kayman-mk merged commit 8348f80 into cattle-ops:main Oct 5, 2023
18 checks passed
@kayman-mk kayman-mk deleted the kayma/docs branch October 5, 2023 09:56
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.

1 participant