Skip to content

add npm jobs for building docs from local website repo #19

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

Merged
William-Woodard merged 2 commits into from
Oct 27, 2021
Merged

add npm jobs for building docs from local website repo #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a177879
allow docs build from local changes
casheww Oct 27, 2021
7a8443c
make wiki a bit clearer
casheww Oct 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Shepherd is the code management system used on the RoboCon brains. For more
infomation about how to use it see
[here](https://hr-robocon.org/docs/connecting.html). Eventually there will be
technical documentation about how shepherd works
[here](https://github.com/systemetric/shepherd/wiki)
[here](https://github.com/systemetric/shepherd/tree/master/wiki)

## Shepherd itself

Expand Down
2 changes: 2 additions & 0 deletions sheepsrc/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@
"start": "cross-env NODE_ENV=development webpack-dev-server",
"build": "rimraf ../shepherd/blueprints/staticroutes/editor/*.* && cross-env NODE_ENV=production webpack --progress --config webpack.config.js",
"vuepress:update": "rimraf ./docs/full && rimraf ./docs/*.md && git clone --depth 1 https://github.com/systemetric/robocon-website ./docs/full && cpy ./docs/full/docs/*.md ./docs/ && cpy ./docs/full/.vuepress/public/images/*.* ./docs/images/ && cpy ./docs/full/.vuepress/categories.json ./docs/.vuepress/ && cpy ./docs/full/.vuepress/public/*.pdf ./docs/.vuepress/public && cpy ./docs/full/.vuepress/public/*.zip ./docs/.vuepress/public && cpy ./docs/full/.vuepress/public/*.py ./docs/.vuepress/public && node ./docs/transform.js && rimraf ./docs/full",
"vuepress:update-local": "rimraf ./docs/full && rimraf ./docs/*.md && git clone --depth 1 ../../robocon-website ./docs/full && cpy ./docs/full/docs/*.md ./docs/ && cpy ./docs/full/.vuepress/public/images/*.* ./docs/images/ && cpy ./docs/full/.vuepress/categories.json ./docs/.vuepress/ && cpy ./docs/full/.vuepress/public/*.pdf ./docs/.vuepress/public && cpy ./docs/full/.vuepress/public/*.zip ./docs/.vuepress/public && cpy ./docs/full/.vuepress/public/*.py ./docs/.vuepress/public && node ./docs/transform.js && rimraf ./docs/full",
"vuepress:dev": "vuepress dev docs",
"vuepress:build": "vuepress build docs --dest ../shepherd/blueprints/staticroutes/docs/",
"vuepress:updatebuild-local": "npm run vuepress:update-local && npm run vuepress:build",
"updatebuild": "npm run vuepress:update && npm run vuepress:build && npm run build"
},
"dependencies": {
Expand Down
22 changes: 13 additions & 9 deletions wiki/Tool's-required-for-updating.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,21 @@ Optionally:
* `git clone https://github.com/systemetric/robocon-website`
* `git clone https://github.com/systemetric/shepherd` (note must have an account which is a member of systemetric organsiation and has access to the shepherd).

# Update the docs
# Update the docs for the BrainBox

* Update shepherd with the lastest docs:
* `cp robocon-website/docs/ shepherd/sheepsrc/docs/ -r`
* Compile the docs:
* `cd shepherd/sheepsrc/`
* `shepherd/sheepsrc> npm install`
* `shepherd/sheepsrc> npm run vuepress:update`
* `shepherd/sheepsrc> npm run vuepress:build`
From systemetric/robocon-website:master *(recommended)*:
* `cd shepherd/sheepsrc/`
* `shepherd/sheepsrc> npm install`
* `shepherd/sheepsrc> npm run vuepress:update`
* `shepherd/sheepsrc> npm run vuepress:build`

This should create a built version of the docs in `shepherd/blueprints/staticroutes/docs`.
From a local clone of the robocon-website *(only for testing local changes)*:
* Start from a dir containing both robocon-website and shepherd
* `cd shepherd/sheepsrc/`
* `shepherd/sheepsrc> npm install`
* `shepher/sheepsrc> npm run vuepress:updatebuild-local`

This should create a built version of the docs in `shepherd/shepherd/blueprints/staticroutes/docs`.

# Update sheep with new code changes

Expand Down