larryh/corso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add docs and commands to setup the container image (#49)

Browse Source
This commit is contained in:
Niraj Tolia 2022-05-19 10:29:25 -07:00 committed by GitHub
parent 038d94b818
commit 5f7f5736ed
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/Dockerfile
View File

@ -3,8 +3,6 @@ LABEL MAINTAINER="Niraj Tolia"
ARG DEBIAN_FRONTEND=noninteractive
WORKDIR /usr/src/docs
RUN apt-get -y update && apt-get -y install gpg emacs curl \
&& curl -fsSL https://deb.nodesource.com/setup_current.x | bash - \
&& apt-get -y install nodejs \
@ -14,4 +12,11 @@ RUN apt-get -y update && apt-get -y install gpg emacs curl \
&& cd /tmp && curl -O -L https://github.com/errata-ai/vale/releases/download/v2.15.4/vale_2.15.4_Linux_64-bit.tar.gz \
&& tar -xvzf vale_2.15.4_Linux_64-bit.tar.gz -C /usr/bin vale
WORKDIR /usr/src
COPY package.json package-lock.json* ./
RUN npm ci && npm cache clean --force && rm -f package.json package-lock.json*
ENV PATH /usr/src/node_modules/.bin:$PATH
WORKDIR /usr/src/docs
CMD ["npm", "start", "--", "--host", "0.0.0.0"]

29
docs/README.md
View File

@ -1,41 +1,34 @@
# Website
# Corso Documentation
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
Corso documentation is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ yarn
$ make buildimage
```
### Local Development
### Live Docs
```
$ yarn start
$ make dev
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
This command starts a local development server within the Docker container and will expose docs at http://localhost:3000.
### Build
### Build Docs
```
$ yarn build
$ make build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
### Documentation Platform Development
Using SSH:
```
$ USE_SSH=true yarn deploy
$ make shell
```
Not using SSH:
```
$ GIT_USER=<Your GitHub username> yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
This command is when you want to interactively (and temporarily!) change the contents or configuration of the live documentation container image.