Skip to content
This repository was archived by the owner on Dec 13, 2023. It is now read-only.

Commit ac42249

Browse files
committed
Improve oasisctl.rb instructions
1 parent d0c9f92 commit ac42249

File tree

1 file changed

+28
-9
lines changed

1 file changed

+28
-9
lines changed

oasisctl.rb

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,40 @@
1010
#
1111
# Usage:
1212
#
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
1421
# (oasisctl-*.md but not oasisctl-getting-started.md and oasisctl.md!)
1522
#
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:
1737
#
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:
2041
#
21-
# 4. Run this script
22-
# > ruby oasisctl.rb /path/to/generated/docs ./oasis
42+
# Then paste the copied text and save the file.
2343
#
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
2645
#
27-
# 6. Verify the changes and commit added and removed files
46+
# 9. Verify the changes and commit added and removed files
2847
#
2948

3049
require 'pathname'

0 commit comments

Comments
 (0)