docs: migrate README to MkDocs #884
Merged
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
knqyf263
added
the
kind/documentation
Codecov Report
@@ Coverage Diff @@
## main #884 +/- ##
==========================================
- Coverage 68.50% 61.80% -6.70%
==========================================
Files 57 65 +8
Lines 2210 2579 +369
==========================================
+ Hits 1514 1594 +80
- Misses 564 849 +285
- Partials 132 136 +4
Continue to review full report at Codecov.
|
danielpacak
suggested changes
Mar 13, 2021
There was a problem hiding this comment.
I left a few comments to start with, but overall
- I suggest that we define a Makefile target to preview the docs locally. See for example https://github.com/aquasecurity/starboard/blob/main/Makefile#L126
- We should use relative links to Markdown sources instead of absolute URLs
- In installation section I think it's worth using macros plugin and define a variable that holds the current release version and refer to that. See for example https://github.com/aquasecurity/starboard/blob/main/mkdocs.yml#L60
Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com>
Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com>
Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com>
Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com>
Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com>
Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com>
This PR was already big, so I thought I should add it in another PR. But I've added here.
I didn't know MkDocs also supports relative links. Thanks!
You can see what I did here. |
danielpacak
approved these changes
Mar 16, 2021
Makefile
Outdated
| @@ -5,6 +5,9 @@ GOPATH=$(shell go env GOPATH) | |||
| GOBIN=$(GOPATH)/bin | |||
| GOSRC=$(GOPATH)/src | |||
|
|
|||
| MKDOCS_IMAGE := aquasec/mkdocs-material:starboard | |||
There was a problem hiding this comment.
NIT You may want to rename tag to dev or trivy
There was a problem hiding this comment.
My bad... Done 098a322
sishbi
pushed a commit
to sishbi/trivy
that referenced
this pull request
Mar 29, 2021
* docs: slim README * docs: add images * docs: update README * docs: add futher reading * docs: add docs for maintainers * docs: fix links * docs: add notes * Update docs/further.md Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com> * Update docs/further.md Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com> * Update docs/further.md Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com> * Update docs/index.md Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com> * Update docs/index.md Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com> * Update docs/index.md Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com> * docs: update mkdocs.yml * chore: add a mkdocs target to Makefile * docs(installation): use git.tag * chore(Makefile): fix the tag of the mkdocs image Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com>
liamg
pushed a commit
that referenced
this pull request
Jun 7, 2022
* docs: slim README * docs: add images * docs: update README * docs: add futher reading * docs: add docs for maintainers * docs: fix links * docs: add notes * Update docs/further.md Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com> * Update docs/further.md Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com> * Update docs/further.md Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com> * Update docs/index.md Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com> * Update docs/index.md Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com> * Update docs/index.md Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com> * docs: update mkdocs.yml * chore: add a mkdocs target to Makefile * docs(installation): use git.tag * chore(Makefile): fix the tag of the mkdocs image Co-authored-by: Daniel Pacak <pacak.daniel@gmail.com>
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.
Overview
This PR migrates README to MkDocs. MkDocs manages two streams:
mainbranchaquasecurity.github.io/trivyredirects tolatestGitHub Pages
https://aquasecurity.github.io/trivy/latest/
References
https://squidfunk.github.io/mkdocs-material/reference/admonitions/