|
10 | 10 | # |
11 | 11 | # Usage: |
12 | 12 | # |
13 | | -# 1. Remove the generated files from the docs target folder |
| 13 | +# 1. Download the latest oasisctl release (oasisctl.zip): |
| 14 | +# https://github.com/arangodb-managed/oasisctl/releases |
| 15 | +# |
| 16 | +# 2. Unzip the relevant binary for your operating system, e.g. |
| 17 | +# bin/darwin/arm64/oasisctl for an M1 macOS device or |
| 18 | +# bin\windows\amd64\oasisctl.exe for an x86-64 Windows device. |
| 19 | +# |
| 20 | +# 3. Remove the old generated files from the docs target folder |
14 | 21 | # (oasisctl-*.md but not oasisctl-getting-started.md and oasisctl.md!) |
15 | 22 | # |
16 | | -# 2. Create a temporary folder (oasisctl defaults to --output-dir ./docs) |
| 23 | +# 4. Create a temporary folder (oasisctl defaults to --output-dir ./docs) |
| 24 | +# |
| 25 | +# 5. Generate the documentation by running the following command in a terminal: |
| 26 | +# |
| 27 | +# oasisctl generate-docs --link-file-ext .html --replace-underscore-with - |
| 28 | +# |
| 29 | +# 6. Run this script with Ruby in a terminal, using the previously generated |
| 30 | +# files as input and the Oasis documentation folder as output: |
| 31 | +# |
| 32 | +# ruby oasisctl.rb /path/to/generated/docs /path/to/3.x/oasis |
| 33 | +# |
| 34 | +# 7. This script prints the navigation definition for the new files to the |
| 35 | +# terminal. Copy the text, open _data/oasis.yml, and remove everything after |
| 36 | +# the following block: |
17 | 37 | # |
18 | | -# 3. Generate the documentation |
19 | | -# > oasisctl generate-docs --link-file-ext .html --replace-underscore-with - |
| 38 | +# - text: Oasisctl |
| 39 | +# href: oasisctl.html |
| 40 | +# children: |
20 | 41 | # |
21 | | -# 4. Run this script |
22 | | -# > ruby oasisctl.rb /path/to/generated/docs ./oasis |
| 42 | +# Then paste the copied text and save the file. |
23 | 43 | # |
24 | | -# 5. This script prints navigation definition entries to stdout. |
25 | | -# Update _data/oasis.yml accordingly. |
| 44 | +# 8. Add the updated and new (untracked) files in Git and commit the changes |
26 | 45 | # |
27 | | -# 6. Verify the changes and commit added and removed files |
| 46 | +# 9. Verify the changes and commit added and removed files |
28 | 47 | # |
29 | 48 |
|
30 | 49 | require 'pathname' |
|
0 commit comments