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

Clean up docs #809

Closed
tcompa opened this issue Jul 25, 2023 · 2 comments · Fixed by #811
Closed

Clean up docs #809

tcompa opened this issue Jul 25, 2023 · 2 comments · Fixed by #811
Assignees
Labels
documentation Improvements or additions to documentation maintenance

Comments

@tcompa
Copy link
Collaborator

tcompa commented Jul 25, 2023

(based on @ychiucco's work in the tasks repo)

@tcompa tcompa changed the title Clean up doc-requirements.txt and docs group in pyproject Clean up docs Jul 27, 2023
@tcompa
Copy link
Collaborator Author

tcompa commented Jul 27, 2023

Based on work in the tasks/client repo's, we should also clean up the docs here.

  • Prune any unnecessary dependency from both docs/docs-requirements.txt and {pyproject.toml, poetry.lock}
  • Update GitHub actions:
    • Remove the docs part from the CI github action into an independent documentation.yaml, and also remove the creation of openapi.json
    • Copy the excat github action we have in tasks/client
    • Add a new preliminary job that: (1) install poetry, (2) set-up python, (3) poetry install --without dev --with doc, (4) create openapi.json. EDIT: we are now moving to pip, in the other repo's.
  • Make the mkdocs.yml configuration (and docs folder) as similar as possible to the ones in tasks/client:
    • add extra.css, and the new css info in mkdocs.yml
    • make handlers/python options as similar as possible to the others
    • make theme/features as similar as possible (e.g. add content.code.copy)
    • make site_name specific ("Fractal Server"?)
    • add copyright footer, linking to LICENSE.md
    • anything else which is needed to have three homogeneous docs pages for the three projects

@tcompa
Copy link
Collaborator Author

tcompa commented Jul 28, 2023

The relevant openapi block will look like

      - name: extract openapi schema
        env:
          DEPLOYMENT_TYPE: development
          JWT_SECRET_KEY: 1234
          DATA_DIR_ROOT: /tmp/fractal-server/
          FRACTAL_TASKS_DIR: /tmp/fractal-server/tasks/
          FRACTAL_RUNNER_WORKING_BASE_DIR: /tmp/fractal-server/artifacts/
        run: fractalctl openapi --openapi-file docs/openapi.json

@ychiucco ychiucco mentioned this issue Jul 28, 2023
@ychiucco ychiucco linked a pull request Jul 28, 2023 that will close this issue
@tcompa tcompa added the documentation Improvements or additions to documentation label Jul 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants