R3d91ll 135bca41de
Docker Documentation (#1251)
* Updates to the Dockerfiles making them more secure. update to the installation.md file and a start.sh file for the Dockerfile.dev to start the document server. Not ready for pull request.

* updates to the docker documentation

* clean up before commit

* added docker instructions on how to test  documentation prior to commit.

* fixed the title heading in the installation.md

* removed alternate yarn install from Dockerfile.dev

* Update sidebars.js

removed un-related change from website/sidebars.js

* cleaned up the lint errors from the pre-commit-check.

* removed bad edit from sidebars.js

* fixing git conflict with sidebars.js file

* Update Installation.md

added the missing sections back. However, do we still want the docker section under the Optional Dependencies? That looks like it would go better in the Dockerfiles.md file.

* Update Installation.md

Added mount your code back and added mount your directory for better clarity.

* Update Installation.md

Lint cleanup

* Update Installation.md

removed the relative path to samples/dockers/Dockerfiles.md with a proper URL to where it will exist

* fixed bad link to Dockerfiles.md

* Fix trailing whitespace and formatting issues

* Update link to Dockerfiles.md

* somtimes its really hard to find that lost i.

* trailing whitespace and EOF issues resolved

* fixed broken link

* trailing space an broken link

* removed broken links. will update one merged.

* fixed glaring error about building an image from a particular branch Contribute.md

* removed tic mark typo from contribute.md

---------

Co-authored-by: Todd W Bucy <todd.bucy@rackspace>
2024-01-15 17:15:59 +00:00
..
2024-01-13 14:54:37 +00:00
2024-01-15 17:15:59 +00:00
2023-12-30 03:53:39 +00:00
2021-12-16 17:11:33 -08:00
2023-08-27 21:30:54 -04:00
2024-01-13 14:54:37 +00:00
2024-01-13 14:54:37 +00:00
2023-08-27 21:32:15 -04:00
2024-01-13 14:54:37 +00:00
2024-01-13 14:54:37 +00:00

Website

This website is built using Docusaurus 2, a modern static website generator.

Prerequisites

To build and test documentation locally, begin by downloading and installing Node.js, and then installing Yarn. On Windows, you can install via the npm package manager (npm) which comes bundled with Node.js:

npm install --global yarn

Installation

pip install pydoc-markdown
cd website
yarn install

Local Development

Navigate to the website folder and run:

pydoc-markdown
yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.