Skip to content

docs: Update automation scripts for versions/ directory structure #111

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

Closed
wants to merge 1 commit into from
Closed

docs: Update automation scripts for versions/ directory structure #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,18 @@ This tool implements the improvements outlined in [Bazel Docs: Why It Might Be T

https://bazel.online

## Repository Structure

- **Root directory**: Contains the latest (HEAD) documentation
- **versions/ directory**: Contains version-specific documentation (e.g., `versions/8.4.2/`, `versions/7.7.0/`)
- **upstream/**: Git submodule containing the source Bazel repository

## How it works

1. Clones the Devsite source from `bazel.build/docs` using a git submodule.
1. Clones the Devsite source from `bazel.build/docs` using a git submodule (`upstream/`).
2. Transforms Devsite frontmatter and directory layout into MDX format.
3. Hosted on Mintlify
3. Version-specific docs are organized in the `versions/` directory.
4. Hosted on Mintlify at https://bazel.online

## Usage

Expand Down
8 changes: 4 additions & 4 deletions docs-versions.vendor_folders.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ VERSIONS=$(jq -r '.[] | select(. != "HEAD")' docs-versions.json)

# Check which folders are missing and create them
for VERSION in $VERSIONS; do
if [ ! -d "$VERSION" ]; then
if [ ! -d "versions/$VERSION" ]; then
echo "Creating missing folder for version: $VERSION"

# Change to upstream directory and reset to the specific tag
Expand All @@ -29,12 +29,12 @@ for VERSION in $VERSIONS; do
cd ..

# Run the copy-upstream-docs.sh script with the version directory
echo "Copying docs to directory: $VERSION"
./copy-upstream-docs.sh "$VERSION"
echo "Copying docs to directory: versions/$VERSION"
./copy-upstream-docs.sh "versions/$VERSION"

echo "Successfully created docs for version $VERSION"
else
echo "Folder $VERSION already exists, skipping"
echo "Folder versions/$VERSION already exists, skipping"
fi
done

Expand Down
Loading