docs/dasharo-tools-suite: Split DTS documentation #959
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
Split the content of documentation.md file into the following structure: documentation/ building.md features.md running.md supported-hardware.md Signed-off-by: Eduard Kaverinskyi <[email protected]>
m-iwanicki
requested changes
Dec 11, 2024
There was a problem hiding this comment.
-
Next time fix all pre-commit errors before asking for review as currently I stopped review as I'm just reiterating errors that pre-commit detected.
-
You should also build website locally (
mkdocs serve) and check if everything looks ok after your changes -
You should read all the warnings that are displayed by
mkserveespecially if they are different before/after your changes e.g. there is a lot of warning of type:WARNING - Doc file 'unified/msi/hcl.md' contains a relative link '../../dasharo-tools-suite/documentation.md#hcl-report', but the target 'dasharo-tools-suite/documentation.md' is not found among documentation files.
Signed-off-by: Eduard Kaverinskyi <[email protected]>
Signed-off-by: Eduard Kaverinskyi <[email protected]>
Signed-off-by: Eduard Kaverinskyi <[email protected]>
Signed-off-by: Eduard Kaverinskyi <[email protected]>
|
I forget about installing pre-commit all the time 😵 |
Signed-off-by: Eduard Kaverinskyi <[email protected]>
Signed-off-by: Eduard Kaverinskyi <[email protected]>
|
@m-iwanicki Fixed headers, pre-commit and mkdocs issues. All checks pass. Also merged master branch for compatibility. |
m-iwanicki
requested changes
Dec 12, 2024
Signed-off-by: Eduard Kaverinskyi <[email protected]>
Signed-off-by: Eduard Kaverinskyi <[email protected]>
…mands list Signed-off-by: Eduard Kaverinskyi <[email protected]>
Signed-off-by: Eduard Kaverinskyi <[email protected]>
Signed-off-by: Eduard Kaverinskyi <[email protected]>
… EC Update" This reverts commit 0c85951.
Signed-off-by: Eduard Kaverinskyi <[email protected]>
m-iwanicki
approved these changes
Dec 12, 2024
artur-rs
requested changes
Dec 12, 2024
…ware list Signed-off-by: Eduard Kaverinskyi <[email protected]>
…KGPE-D16 Signed-off-by: Eduard Kaverinskyi <[email protected]>
artur-rs
approved these changes
Dec 12, 2024
5 tasks
krystian-hebel
added a commit
to 3mdeb/news-and-ideas
that referenced
this pull request
Dec 13, 2024
Dasharo/docs#959 split DTS documentation into multiple files. Signed-off-by: Krystian Hebel <[email protected]>
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.
Split the content of documentation.md file into the following structure:
documentation/
building.md
features.md
running.md
supported-hardware.md