docs: reorganise documentation with different main sections #2260
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
This allows to test the website locally. Signed-off-by: Alban Crequy <albancrequy@linux.microsoft.com>
alban
force-pushed
the
alban_docs3
branch
2 times, most recently
from
bc758e2
to
5ee8d37
Compare
|
I fixed the broken links. It is ready for review. |
There was a problem hiding this comment.
Any reason not to have script and traceloop here too?
There was a problem hiding this comment.
Since they are built-in gadgets, they are in the builtin-gadgets section.
There was a problem hiding this comment.
I don't see the built-in gadgets section while testing locally. Did you forget git add docs/builtin-gadgets/_index.md?
There was a problem hiding this comment.
You're right, I forgot it. It's added now.
The documentation now has the following main sections: - getting started: installation instructions split by target - core concepts - development - guides - built-in gadgets Signed-off-by: Alban Crequy <albancrequy@linux.microsoft.com>
Signed-off-by: Alban Crequy <albancrequy@linux.microsoft.com>
Since we want to move towards image-based gadgets instead of built-in gadgets, it does not make sense for the documentation to focus on built-in gadgets. Signed-off-by: Alban Crequy <albancrequy@linux.microsoft.com>
Signed-off-by: Alban Crequy <albancrequy@linux.microsoft.com>
mauriciovasquezbernal
approved these changes
Dec 5, 2023
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.
docs: reorganise documentation
The documentation now has the following main sections:
How to use
Testing done