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

Old API docs are no longer available #467

Open
azeey opened this issue Jul 30, 2024 · 0 comments
Open

Old API docs are no longer available #467

azeey opened this issue Jul 30, 2024 · 0 comments
Assignees
Labels
bug Something isn't working

Comments

@azeey
Copy link
Contributor

azeey commented Jul 30, 2024

With the new website deployment implemented in #441, old API docs (e.g. https://gazebosim.org/api/transport/9.0/tutorials.html) are no longer available. This has caused a some broken links (see #466 and #461). My plan is to manually import them from AWS, but the total size is about 9GB. This is mainly because we used to generate API docs for minor versions as shown below.

Directory structure of API docs
~/tmp/api on  main ❯ tree -L 2
.
├── cmake
│   ├── 2
│   ├── 3
│   └── 4
├── common
│   ├── 0
│   ├── 0.1
│   ├── 0.2
│   ├── 0.3
│   ├── 0.4
│   ├── 1.0
│   ├── 2.0
│   ├── 3
│   ├── 3.0
│   ├── 3.1
│   ├── 3.10
│   ├── 3.11
│   ├── 3.12
│   ├── 3.13
│   ├── 3.14
│   ├── 3.3
│   ├── 3.5
│   ├── 3.6
│   ├── 3.7
│   ├── 3.8
│   ├── 3.9
│   ├── 4
│   ├── 4.0
│   ├── 4.1
│   ├── 4.2
│   ├── 4.3
│   ├── 4.4
│   ├── 4.5
│   ├── 5
│   └── 6
├── fuel_tools
│   ├── 1
│   ├── 1.0
│   ├── 2
│   ├── 2.0
│   ├── 3
│   ├── 3.0
│   ├── 3.1
│   ├── 3.2
│   ├── 3.3
│   ├── 3.4
│   ├── 3.5
│   ├── 4
│   ├── 4.0
│   ├── 4.1
│   ├── 4.2
│   ├── 4.3
│   ├── 4.4
│   ├── 5
│   ├── 5.0
│   ├── 5.1
│   ├── 5.2
│   ├── 6
│   ├── 6.0
│   ├── 6.1
│   ├── 6.2
│   ├── 7
│   ├── 7.0
│   ├── 8
│   ├── 8.0
│   └── 9
├── gazebo
│   ├── 0
│   ├── 0.1
│   ├── 1
│   ├── 1.0
│   ├── 1.1
│   ├── 2
│   ├── 2.0
│   ├── 2.10
│   ├── 2.16
│   ├── 2.23
│   ├── 2.24
│   ├── 2.25
│   ├── 3
│   ├── 3.0
│   ├── 3.10
│   ├── 3.11
│   ├── 3.12
│   ├── 3.2
│   ├── 3.3
│   ├── 3.4
│   ├── 3.5
│   ├── 3.6
│   ├── 3.7
│   ├── 3.8
│   ├── 3.9
│   ├── 4
│   ├── 4.0
│   ├── 4.1
│   ├── 4.10
│   ├── 4.11
│   ├── 4.12
│   ├── 4.13
│   ├── 4.14
│   ├── 4.2
│   ├── 4.3
│   ├── 4.4
│   ├── 4.5
│   ├── 4.6
│   ├── 4.7
│   ├── 4.8
│   ├── 4.9
│   ├── 5
│   ├── 5.0
│   ├── 5.1
│   ├── 5.2
│   ├── 5.3
│   ├── 5.4
│   ├── 6
│   ├── 6.0
│   ├── 6.1
│   ├── 6.2
│   ├── 6.3
│   ├── 6.4
│   ├── 6.5
│   ├── 6.6
│   ├── 6.7
│   ├── 6.8
│   ├── 6.9
│   ├── 7
│   └── 7.0
├── gui
│   ├── 0
│   ├── 0.1
│   ├── 1
│   ├── 1.0
│   ├── 2
│   ├── 2.0
│   ├── 2.1
│   ├── 2.2
│   ├── 2.3
│   ├── 3
│   ├── 3.0
│   ├── 3.1
│   ├── 3.2
│   ├── 3.3
│   ├── 3.4
│   ├── 3.5
│   ├── 3.6
│   ├── 3.7
│   ├── 3.8
│   ├── 3.9
│   ├── 4
│   ├── 4.0
│   ├── 4.1
│   ├── 4.2
│   ├── 4.3
│   ├── 4.4
│   ├── 4.5
│   ├── 4.6
│   ├── 5
│   ├── 5.0
│   ├── 5.1
│   ├── 5.2
│   ├── 5.3
│   ├── 5.4
│   ├── 5.5
│   ├── 6
│   ├── 6.0
│   ├── 6.1
│   ├── 6.2
│   ├── 6.3
│   ├── 6.4
│   ├── 7
│   ├── 7.0
│   └── 8
├── launch
│   ├── 0
│   ├── 0.2
│   ├── 1
│   ├── 1.0
│   ├── 1.2
│   ├── 2
│   ├── 2.0
│   ├── 2.1
│   ├── 2.2
│   ├── 3
│   ├── 3.0
│   ├── 3.1
│   ├── 3.2
│   ├── 3.3
│   ├── 3.4
│   ├── 4
│   ├── 4.0
│   ├── 4.1
│   ├── 5
│   ├── 5.0
│   ├── 5.1
│   ├── 6
│   ├── 6.0
│   └── 7
├── math
│   ├── 0
│   ├── 0.1
│   ├── 0.2
│   ├── 1
│   ├── 1.0
│   ├── 2
│   ├── 2.0
│   ├── 2.1
│   ├── 2.2
│   ├── 2.3
│   ├── 2.4
│   ├── 2.5
│   ├── 2.6
│   ├── 2.7
│   ├── 2.8
│   ├── 3
│   ├── 3.1
│   ├── 3.2
│   ├── 4
│   ├── 4.0
│   ├── 5
│   ├── 5.0
│   ├── 5.1
│   ├── 6
│   ├── 6.0
│   ├── 6.1
│   ├── 6.10
│   ├── 6.2
│   ├── 6.4
│   ├── 6.5
│   ├── 6.6
│   ├── 6.7
│   ├── 6.8
│   ├── 6.9
│   ├── 7
│   └── 8
├── msgs
│   ├── 0
│   ├── 0.1
│   ├── 0.2
│   ├── 0.3
│   ├── 0.4
│   ├── 0.5
│   ├── 0.6
│   ├── 0.7
│   ├── 1
│   ├── 1.0
│   ├── 10
│   ├── 3
│   ├── 3.0
│   ├── 3.1
│   ├── 3.2
│   ├── 4
│   ├── 4.0
│   ├── 4.7
│   ├── 4.8
│   ├── 4.9
│   ├── 5
│   ├── 5.0
│   ├── 5.1
│   ├── 5.3
│   ├── 5.4
│   ├── 5.5
│   ├── 5.6
│   ├── 5.7
│   ├── 5.8
│   ├── 5.9
│   ├── 6
│   ├── 6.0
│   ├── 6.1
│   ├── 6.2
│   ├── 6.3
│   ├── 6.4
│   ├── 6.5
│   ├── 6.6
│   ├── 7
│   ├── 7.0
│   ├── 7.1
│   ├── 7.2
│   ├── 7.3
│   ├── 8
│   ├── 8.0
│   ├── 8.1
│   ├── 8.2
│   ├── 8.3
│   ├── 8.4
│   ├── 9
│   └── 9.0
├── physics
│   ├── 0
│   ├── 0.1
│   ├── 1
│   ├── 1.0
│   ├── 1.1
│   ├── 1.10
│   ├── 1.2
│   ├── 1.4
│   ├── 1.7
│   ├── 1.8
│   ├── 1.9
│   ├── 2
│   ├── 2.0
│   ├── 2.2
│   ├── 2.3
│   ├── 2.4
│   ├── 2.5
│   ├── 3
│   ├── 3.0
│   ├── 3.1
│   ├── 3.2
│   ├── 3.3
│   ├── 3.4
│   ├── 4
│   ├── 4.0
│   ├── 4.1
│   ├── 4.2
│   ├── 4.3
│   ├── 5
│   ├── 5.0
│   ├── 5.1
│   ├── 6
│   ├── 6.0
│   └── 7
├── plugin
│   ├── 1
│   ├── 1.0
│   ├── 1.1
│   ├── 1.2
│   └── 2
├── rendering
│   ├── 0
│   ├── 0.1
│   ├── 1
│   ├── 1.0
│   ├── 2
│   ├── 2.0
│   ├── 2.1
│   ├── 2.4
│   ├── 2.5
│   ├── 3
│   ├── 3.0
│   ├── 3.1
│   ├── 3.2
│   ├── 3.3
│   ├── 3.4
│   ├── 3.5
│   ├── 3.6
│   ├── 4
│   ├── 4.0
│   ├── 4.1
│   ├── 4.2
│   ├── 4.3
│   ├── 4.4
│   ├── 4.5
│   ├── 4.6
│   ├── 4.7
│   ├── 4.8
│   ├── 4.9
│   ├── 5
│   ├── 5.0
│   ├── 5.1
│   ├── 5.2
│   ├── 6
│   ├── 6.0
│   ├── 6.1
│   ├── 6.2
│   ├── 6.3
│   ├── 7
│   ├── 7.0
│   └── 8
├── sdformat
│   ├── 12
│   ├── 13
│   ├── 14
│   └── 9
├── sensors
│   ├── 0
│   ├── 0.1
│   ├── 1
│   ├── 1.0
│   ├── 2
│   ├── 2.0
│   ├── 2.6
│   ├── 2.8
│   ├── 2.9
│   ├── 3
│   ├── 3.0
│   ├── 3.1
│   ├── 3.2
│   ├── 3.3
│   ├── 4
│   ├── 4.0
│   ├── 4.1
│   ├── 4.2
│   ├── 4.3
│   ├── 5
│   ├── 5.0
│   ├── 5.1
│   ├── 6
│   ├── 6.0
│   ├── 6.1
│   ├── 6.2
│   ├── 6.3
│   ├── 7
│   ├── 7.0
│   └── 8
├── sim
│   ├── 0
│   ├── 0.1
│   ├── 1
│   ├── 1.0
│   ├── 1.1
│   ├── 2
│   ├── 2.0
│   ├── 2.10
│   ├── 2.16
│   ├── 2.23
│   ├── 2.24
│   ├── 2.25
│   ├── 3
│   ├── 4
│   ├── 5
│   ├── 6
│   ├── 7
│   └── 8
├── tools
│   ├── 1
│   └── 2
├── transport
│   ├── 0
│   ├── 0.3
│   ├── 0.4
│   ├── 0.5
│   ├── 0.6
│   ├── 0.7
│   ├── 0.8
│   ├── 0.9
│   ├── 1
│   ├── 1.0
│   ├── 10
│   ├── 10.0
│   ├── 10.1
│   ├── 10.2
│   ├── 1.1
│   ├── 11
│   ├── 11.0
│   ├── 1.2
│   ├── 12
│   ├── 12.0
│   ├── 1.3
│   ├── 13
│   ├── 1.4
│   ├── 2
│   ├── 2.0
│   ├── 2.1
│   ├── 3
│   ├── 3.0
│   ├── 4
│   ├── 4.0
│   ├── 5
│   ├── 5.0
│   ├── 6
│   ├── 6.0
│   ├── 7
│   ├── 7.0
│   ├── 7.1
│   ├── 7.4
│   ├── 7.5
│   ├── 8
│   ├── 8.0
│   ├── 8.1
│   ├── 8.2
│   ├── 9
│   ├── 9.0
│   └── 9.1
└── utils
    ├── 1
    └── 2

My plan is to manually copy API docs from the major version directories and fix any broken links here if necessary.

@azeey azeey added the bug Something isn't working label Jul 30, 2024
@azeey azeey self-assigned this Jul 30, 2024
@azeey azeey moved this from Inbox to To do in Core development Jul 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: To do
Development

No branches or pull requests

1 participant