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

Remove apidocs completely #1808

Merged
merged 1 commit into from
May 12, 2021
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.
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
18 changes: 1 addition & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,20 +69,4 @@ For each new release we keep stable documentation tree for the record.

## Updating API Auto-Generated Docs by apipie

Generate API docs in Foreman

1. cd to foreman directory and checkout the relevant stable branch
1. disable any plugins installed locally
1. `APIPIE_RECORD=examples rake test`
1. `FOREMAN_APIPIE_LANGS=en rake apipie:cache`

Prepare folder for the new version (X.Y)

1. cd to theforeman.org/api directory
1. `cp -r new_version_template X.Y`
1. edit file X.Y/index.md and set correct version

Copy docs to repo

1. `cp -r dir/to/foreman/public/apipie-cache/apidoc/* Y.Y/apidoc`
1. `find Y.Y -name *.json -delete`
Follow instructions in the [apidocs github repo](https://github.com/theforeman/apidocs#adding-new-version).
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ navigation:
- title: Plugins
url: /plugins/
- title: API docs
url: /api/latest/index.html
url: https://apidocs.theforeman.org/foreman/latest/apidoc/v2.html
- title: Training
url: /training.html
- title: Support
Expand Down
17 changes: 0 additions & 17 deletions _layouts/api_v2.html

This file was deleted.

5 changes: 0 additions & 5 deletions api/1.1/index.md

This file was deleted.

5 changes: 0 additions & 5 deletions api/1.10/index.md

This file was deleted.

5 changes: 0 additions & 5 deletions api/1.11/index.md

This file was deleted.

5 changes: 0 additions & 5 deletions api/1.12/index.md

This file was deleted.

5 changes: 0 additions & 5 deletions api/1.13/index.md

This file was deleted.

5 changes: 0 additions & 5 deletions api/1.14/index.md

This file was deleted.

5 changes: 0 additions & 5 deletions api/1.15/index.md

This file was deleted.

5 changes: 0 additions & 5 deletions api/1.16/index.md

This file was deleted.

5 changes: 0 additions & 5 deletions api/1.17/index.md

This file was deleted.

5 changes: 0 additions & 5 deletions api/1.18/index.md

This file was deleted.

6 changes: 0 additions & 6 deletions api/1.19/apidoc/javascripts/apipie.js

This file was deleted.

138 changes: 0 additions & 138 deletions api/1.19/apidoc/javascripts/bundled/bootstrap-collapse.js

This file was deleted.