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

add core documentation in website #11

Open
flomonster opened this issue May 5, 2022 · 1 comment
Open

add core documentation in website #11

flomonster opened this issue May 5, 2022 · 1 comment
Assignees

Comments

@flomonster
Copy link
Contributor

flomonster commented May 5, 2022

  • Add a step to the CI that generate core documentation.
    • Use gradle javadoc to generate docs.
  • Unzip documentation and add content the content to the branch.
@flomonster flomonster changed the title Attach core documentation Adapt CI to integrate osrd-core documentation May 23, 2022
@elzinko elzinko self-assigned this May 31, 2022
@elzinko
Copy link
Contributor

elzinko commented Jun 7, 2022

Détails :

core side

  • generate javadoc during core build
  • create an artifact from generated doc
  • commit artifact to osrd-website master branch

website side

  • unzip in static folder
  • add javadoc link from hugo cms theme

Thoughts :

  • next step is to use package and package registry (or equivalents) for such task.
  • possibly commit directly javadoc (without zip) in osrd-website static folder

@elzinko elzinko changed the title Adapt CI to integrate osrd-core documentation add core documentation in website Jun 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants