8000 docs: fix formatting on prerequisites page by danielpacak · Pull Request #1126 · aquasecurity/tracee · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: fix formatting on prerequisites page #1126

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Nov 8, 2021
Merged

docs: fix formatting on prerequisites page #1126

merged 1 commit into from
Nov 8, 2021

Conversation

danielpacak
Copy link
Contributor
@danielpacak danielpacak commented Nov 8, 2021 •
edited
Loading

Before

docs_prerequisites_before

After

docs_prerequisites_after

Also adding a convenient Make target to preview the documentation on http://localhost:8000 before it's published:

$ make mkdocs-serve
docker build -t aquasec/mkdocs-material:tracee -f docs/Dockerfile docs
[+] Building 0.1s (7/7) FINISHED
 => [internal] load build definition from Dockerfile                                                                                                                           0.0s
 => => transferring dockerfile: 36B                                                                                                                                            0.0s
 => [internal] load .dockerignore                                                                                                                                              0.0s
 => => transferring context: 2B                                                         
8000
                                                                                       0.0s
 => [internal] load metadata for docker.io/squidfunk/mkdocs-material:7.3.4                                                                                                     0.0s
 => [1/3] FROM docker.io/squidfunk/mkdocs-material:7.3.4                                                                                                                       0.0s
 => CACHED [2/3] RUN pip install mike                                                                                                                                          0.0s
 => CACHED [3/3] RUN pip install mkdocs-macros-plugin                                                                                                                          0.0s
 => exporting to image                                                                                                                                                         0.0s
 => => exporting layers                                                                                                                                                        0.0s
 => => writing image sha256:ed2fce93de0bd96a044530f85425d3eaddbda007c06938963f4a4d565eecdf69                                                                                   0.0s
 => => naming to docker.io/aquasec/mkdocs-material:tracee                                                                                                                      0.0s

Use 'docker scan' to run Snyk tests against images to find vulnerabilities and learn how to fix them
docker run --name mkdocs-serve --rm -v /Users/dpacak/go/src/github.com/aquasecurity/tracee:/docs -p 8000:8000 aquasec/mkdocs-material:tracee
INFO     -  Building documentation...
WARNING  -  Config value: 'dev_addr'. Warning: The use of the IP address '0.0.0.0' suggests a production environment or the use of a proxy to connect to the MkDocs server. However, the MkDocs' server is intended for local development purposes only. Please use a third party production-ready server instead.
INFO     -  [macros] - Macros arguments: {'module_name': 'main', 'modules': [], 'include_dir': '', 'include_yaml': [], 'j2_block_start_string': '', 'j2_block_end_string': '', 'j2_variable_start_string': '', 'j2_variable_end_string': '', 'verbose': False}
INFO     -  [macros] - Extra variables (config file): ['generator', 'version']
INFO     -  [macros] - Extra filters (module): ['pretty']
INFO     -  Cleaning site directory
INFO     -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
  - tracee-ebpf/override-os-needed-files.md
WARNING  -  A relative path to 'tracee-ebpf/override-os-needed-files' is included in the 'nav' configuration, which is not found in the documentation files
INFO     -  Documentation built in 0.93 seconds
INFO     -  [11:30:18] Serving on http://0.0.0.0:8000/tracee/

Signed-off-by: Daniel Pacak pacak.daniel@gmail.com

@danielpacak
docs: fix formatting on prerequisites page
cf7da56 
Signed-off-by: Daniel Pacak <pacak.daniel@gmail.com>
yanivagman
yanivagman approved these changes Nov 8, 2021
View reviewed changes
Copy link
Collaborator
@yanivagman yanivagman left a comment

Choose a reason for hiding this comment

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

LGTM

@danielpacak danielpacak merged commit c999952 into aquasecurity:main Nov 8, 2021
@danielpacak danielpacak deleted the docs_formatting_prerequisites branch November 8, 2021 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yanivagman yanivagman yanivagman approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@danielpacak @yanivagman
0