Skip to content

docs: add versioned documentation#664

Merged
JoanFM merged 16 commits intomainfrom
docs-629-versioned-docs
Oct 25, 2022
Merged

docs: add versioned documentation#664
JoanFM merged 16 commits intomainfrom
docs-629-versioned-docs

Conversation

@Jackmin801
Copy link
Copy Markdown
Contributor

@Jackmin801 Jackmin801 commented Oct 23, 2022

Goals:

Docs Changes:

  • Added a version selector to the sidebar in docs/_templates/sidebar/brand.html.

CI changes:

  • Updates the Manual Docs Build workflow (.github/workflows/force-docs-build.yml).

    • This can be run whenever the docs are updated.
    • Changed some steps to be compatible with the new folder structure introduced by versioned docs
    • Increased modularity of steps to increase separation of concerns as well as increase visibility on time taken for each concern.
    • Decreased time taken to fetch code by changing fetches to shallow (depth 1)
  • Added the Build old docs workflow (.github/workflows/build-old-docs.yml)

    • This should be run when a new release is created (because there will be a new old release)
    • The workflow will build the docs for all the versions specified in docs/_versions.json of the main branch
    • Each version of the docs is built by checking out to the release, pulling the latest docs/_templates/sidebar/brand.html in main. Then building with makedoc.sh.
    • Each version is then placed in separate folders in ./docs of the pages_branch.

@Jackmin801
Copy link
Copy Markdown
Contributor Author

Workflow to build latest docs was tested in https://github.com/Jackmin801/JinaDocArrayTest/actions/runs/3307372739/jobs/5458957225

Workflow to build docs for old releases was tested in https://github.com/Jackmin801/JinaDocArrayTest/actions/runs/3307151516

Deployed site from testing workflows: https://docarray.meows.ninja/

@github-actions github-actions bot added size/l and removed size/m labels Oct 23, 2022
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 23, 2022

Codecov Report

Merging #664 (d695c90) into main (108b9d2) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #664   +/-   ##
=======================================
  Coverage   88.48%   88.48%           
=======================================
  Files         133      133           
  Lines        6528     6528           
=======================================
  Hits         5776     5776           
  Misses        752      752           
Flag Coverage Δ
docarray 88.48% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Copy Markdown
Member

@JoanFM JoanFM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We would need an action when doing a Release to add an entry for docs/_versions.json right?

@Jackmin801
Copy link
Copy Markdown
Contributor Author

We would need an action when doing a Release to add an entry for docs/_versions.json right?

Yup. Do we put that in Release CD or Manual Release?

Release CD: https://github.com/jina-ai/docarray/blob/3a888015277f227c79485dcdf7c5dbe40f9516d2/.github/workflows/tag.yml

Manual Release: https://github.com/jina-ai/docarray/blob/3a888015277f227c79485dcdf7c5dbe40f9516d2/.github/workflows/force-release.yml

@JoanFM
Copy link
Copy Markdown
Member

JoanFM commented Oct 24, 2022

We would need an action when doing a Release to add an entry for docs/_versions.json right?

Yup. Do we put that in Release CD or Manual Release?

Release CD: https://github.com/jina-ai/docarray/blob/3a888015277f227c79485dcdf7c5dbe40f9516d2/.github/workflows/tag.yml

Manual Release: https://github.com/jina-ai/docarray/blob/3a888015277f227c79485dcdf7c5dbe40f9516d2/.github/workflows/force-release.yml

in Manual Release

@Jackmin801 Jackmin801 marked this pull request as ready for review October 25, 2022 07:44
@github-actions github-actions bot added size/m and removed size/l labels Oct 25, 2022
@Jackmin801 Jackmin801 force-pushed the docs-629-versioned-docs branch from cd5a80e to 990b0ca Compare October 25, 2022 08:39
@github-actions
Copy link
Copy Markdown

📝 Docs are deployed on https://ft-docs-629-versioned-docs--jina-docs.netlify.app 🎉

@JoanFM JoanFM merged commit 2711aef into main Oct 25, 2022
@JoanFM JoanFM deleted the docs-629-versioned-docs branch October 25, 2022 09:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants