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.

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

Jump to bottom

Move V2 API docs to Github Pages #3874

Merged
merged 13 commits into from
Jul 12, 2024
Merged

Move V2 API docs to Github Pages #3874

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
9bc21b4
FORK - remove automatic triggers on existing GitHub Actions workflows
pivotalgeorge Jun 5, 2024
0bf39cb
Create Action to deploy v3 docs to GitHub Pages
pivotalgeorge Jun 5, 2024
4b73989
set working directory to v3 docs
pivotalgeorge Jun 5, 2024
d6b880b
specify path to static assets
pivotalgeorge Jun 5, 2024
bb2fd1f
Revert "FORK - remove automatic triggers on existing GitHub Actions w…
pivotalgeorge Jun 5, 2024
63240ed
fix path to static assets for upload between jobs
pivotalgeorge Jun 5, 2024
0582277
Add v2 docs push workflow
pivotalgeorge Jun 5, 2024
a901843
fix dependency job name
pivotalgeorge Jun 5, 2024
ccb08a4
Add version info heading panel
pivotalgeorge Jul 1, 2024
09e9860
Add render step to v2 index.html, to populate version info header
pivotalgeorge Jul 4, 2024
f30dd4d
Add v2 render step to Test-Docs job
pivotalgeorge Jul 6, 2024
00b589d
remove v3 docs workflow from current changeset
pivotalgeorge Jul 11, 2024
75ffdff
Move v2 docs workflow to capi-release
pivotalgeorge Jul 12, 2024
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
3 changes: 3 additions & 0 deletions .github/workflows/docs_test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ jobs:
- uses: ./.github/workflows/composite/setup
with:
WORKING_DIRECTORY: docs/v3
- name: Render V2 docs
working-directory: docs/v2
run: ./render.sh
- name: Run docs tests
run: |
bundle config set --local without 'development'
Expand Down
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ test.out
!/.devcontainer/**/*

#DOCS
docs/v2/index.html

docs/v3/*.gem
docs/v3/*.rbc
Expand Down
9 changes: 7 additions & 2 deletions docs/v2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
Cloud Foundry v2 API Docs
=========================

To render these docs locally, run `python3 -m http.server 8000` and view at
`localhost:8000`.
To render these docs locally, run:
```
./render.sh
python3 -m http.server 8000
```

The docs can then be viewed at `localhost:8000`.
14 changes: 14 additions & 0 deletions docs/v2/index.html → docs/v2/index.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,20 @@
</head>
<body>
<div class="container">
<div class="panel panel-info">
<div class="panel-heading">
<h3 class="panel-title">Version Note:</h3>
</div>
<div class="panel-body">
These docs were last changed with
<a href="https://github.com/cloudfoundry/cloud_controller_ng/commit/<%= ENV['DOC_CHANGE_COMMIT'] %>" class="alert-link"><%= ENV['DOC_CHANGE_COMMIT'] %></a>
, and therefore they are up-to-date for CAPI version <%= ENV['DOC_CHANGE_VERSION'] %>.
The V2 API is considered stable, and further changes are not expected.
For previous versions, see the <code>docs/v2</code> directory at
<a href="https://github.com/cloudfoundry/cloud_controller_ng/commits/main/config/version_v2" class="alert-link">the desired version</a>
</div>
</div>

<h1>Cloud Foundry API</h1>

<div class="article">
Expand Down
13 changes: 13 additions & 0 deletions docs/v2/render.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#!/bin/bash
set -euo pipefail

repo_root="$(git rev-parse --show-toplevel)"

pushd "$repo_root"
export DOC_CHANGE_COMMIT="$(git log -1 --format=format:%h -- docs/v2)"
git checkout $DOC_CHANGE_COMMIT -- config/version_v2
export DOC_CHANGE_VERSION="$(cat config/version_v2)"
git checkout -- config/version_v2
popd

erb index.html.erb > index.html