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

Fix JavaDoc integration in module docs #101

Open
jdrueckert opened this issue Apr 22, 2023 · 2 comments
Open

Fix JavaDoc integration in module docs #101

jdrueckert opened this issue Apr 22, 2023 · 2 comments
Labels
Category: Doc Requests, Issues and Changes targeting javadoc and module documentation Size: S Small effort likely only affecting a single area and requiring little to no research Status: Blocked Is currently blocked by missing dependencies, pre-requisites, etc. Type: Bug Issues reporting and PRs fixing problems

Comments

@jdrueckert
Copy link
Member

jdrueckert commented Apr 22, 2023

The API sections in the module docs are currently leading to
image

The links in question are

This is due to the switch to a newer jenkins (http://newerjenkins.terasology.io instead of https://jenkins.terasology.io).

The new javadocs will be available on

once they ran for the first time which they did not do yet.

Blocks #104

@jdrueckert jdrueckert added Type: Bug Issues reporting and PRs fixing problems Category: Doc Requests, Issues and Changes targeting javadoc and module documentation Size: S Small effort likely only affecting a single area and requiring little to no research labels Apr 22, 2023
@Cervator
Copy link
Member

Is this a limited issue on just one or a few modules needing it? I expect the URL will change again, maybe even during the fun a week from now. Easy enough to change a bit, especially if new URL happens later, just wouldn't want to change something per-module while on a temp setup :-)

@jdrueckert
Copy link
Member Author

Is this a limited issue on just one or a few modules needing it? I expect the URL will change again, maybe even during the fun a week from now. Easy enough to change a bit, especially if new URL happens later, just wouldn't want to change something per-module while on a temp setup :-)

Fair point. I don't think we have this kind of doc structure in a lot of modules yet, so it's more of a one off fix. But if you expect it to change it soon again anyway, we can set it to blocked for now. Just have to remember to eventually unblock it again.

@jdrueckert jdrueckert added the Status: Blocked Is currently blocked by missing dependencies, pre-requisites, etc. label Apr 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Doc Requests, Issues and Changes targeting javadoc and module documentation Size: S Small effort likely only affecting a single area and requiring little to no research Status: Blocked Is currently blocked by missing dependencies, pre-requisites, etc. Type: Bug Issues reporting and PRs fixing problems
Projects
None yet
Development

No branches or pull requests

2 participants