-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 326754d
Showing
42 changed files
with
6,806 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
*.mp4 | ||
site | ||
log_local |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
image: python:latest | ||
pages: | ||
stage: deploy | ||
only: | ||
- master | ||
- main | ||
script: | ||
- pip install mkdocs-material | ||
- mkdocs build --site-dir public | ||
artifacts: | ||
paths: | ||
- public | ||
tags: | ||
- pages |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
SPDX-FileCopyrightText: Copyright (c) 2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
SPDX-License-Identifier: Apache-2.0 | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# jetson-min-disk | ||
|
||
Document generation status: [](https://gitlab-master.nvidia.com/cyato/jetson-min-disk/-/commits/main) | ||
|
||
This repo is to host the online guide for minimizing Jetson disk usage, and to host the associated scritps and assets. | ||
|
||
## Full Documentation (internally hosted for now) | ||
https://cyato.gitlab-master-pages.nvidia.com/jetson-min-disk/ | ||
|
||
## About this repo | ||
|
||
This repo is host two things; | ||
|
||
1. Online user guide for "Minimizing Jetson's Disk Usage (Full)". | ||
2. Scripts and text files being referenced in the guide/article | ||
|
||
For now, the auto generated documentation is hosted on NVIDIA's internal GitLab server (`gitlab-master`), and set up with it's CI/CD feature to automatically generate the [internal HTML documentation site](https://cyato.gitlab-master-pages.nvidia.com/jetson-disk-usage/). | ||
|
||
## How to use this repo | ||
|
||
### Mkdocs: Initial setup | ||
|
||
https://squidfunk.github.io/mkdocs-material/getting-started/ | ||
|
||
``` | ||
sudo apt install -y docker.io | ||
sudo docker pull squidfunk/mkdocs-material | ||
``` | ||
|
||
### Mkdocs: Start development server on http://localhost:8000 | ||
|
||
```bash | ||
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material | ||
``` | ||
|
||
> If you get "docker: Got permission denied while trying to connect to the Docker daemon socket at ..." error, | ||
> issue `sudo chmod 666 /var/run/docker.sock` to get around with the issue. | ||
### Mkdocs: To locally build the HTML site | ||
|
||
```bash | ||
docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build | ||
``` |
Oops, something went wrong.