Skip to content
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.

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

chore(docs): add dev docs task #306

Merged
merged 1 commit into from
Jan 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,5 @@ uds-core/**
src/extra-jars/
src/test/cypress/node_modules/**
src/plugin/target/**
uds-docs/
uds-docs/**
20 changes: 20 additions & 0 deletions tasks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -157,3 +157,23 @@ tasks:
actions:
- description: Add the SPDX license identifier to source files
task: remote:fix-license

# Note that due to cloning the docs repo (which is private) this task will require organization access to the repo
# This task does not clone in/manage docs outside of the identity repo so you may hit some 404s during development
- name: dev-docs
description: "Start the dev docs server"
actions:
- description: "Cleanup previous runs"
cmd: |
rm -rf uds-docs
- description: "Clone the docs repo and symlink the reference docs"
cmd: |
git clone https://github.com/defenseunicorns/uds-docs.git uds-docs
rm -rf uds-docs/src/content/docs/reference uds-docs/src/content/docs/.images
# This only symlinks the reference and images folders since these are the only docs we use in the docs site
ln -s $(pwd)/docs/reference uds-docs/src/content/docs/reference
ln -s $(pwd)/docs/.images uds-docs/src/content/docs/.images
- description: "Start the docs server with npm (this will run until you stop it)"
cmd: |
# Actual startup takes up to a minute because of the npm install
cd uds-docs && npm i && npm run dev
Loading