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

Docs/add versioning in docusaurus #415

Conversation

csarnataro
Copy link
Collaborator

@csarnataro csarnataro commented Sep 3, 2019

What:
Added versioning to Docusaurus

Why:
So that (possibly) we can navigate through different versions of data-point.
Currently the only available version is 6.x-canary

How:
Using the version script available in Docusaurus.
See also https://docusaurus.io/docs/en/versioning

Checklist:

  • Has Breaking changes N/A
  • Documentation
  • Tests N/A
  • Ready to be merged
  • Added username to all-contributors list

You can check here https://csarnataro.github.io/data-point/docs/getting-started the version deployed on my fork.

I've added a temporary favicon for DataPoint so that we don't see the default Docusaurus favicon.
But I'm aware that there's this issue for creating a brand new Datapoint logo.

Christian Sarnataro added 3 commits September 3, 2019 22:51
Added versioning support using Docusaurus 'version' command. Added version 6.x-canary. Added
temporary DataPoint logo. Changed primary color to Viacom's blue.

Closes ViacomInc#413
@codecov
Copy link

codecov bot commented Sep 3, 2019

Codecov Report

Merging #415 into canary will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##           canary   #415   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          25     25           
  Lines         424    424           
  Branches       65     65           
=====================================
  Hits          424    424

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dc81612...89d7401. Read the comment docs.

@csarnataro csarnataro closed this Sep 9, 2019
@csarnataro
Copy link
Collaborator Author

I just realised that using docusaurus versioning with just one version is not what I expected to have.
I have the explicit version number near the title (in this case 6.x-canary) but I have no link to the unreleased, more recent, code.
I will try to figure out how to manage this the proper way.

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

Successfully merging this pull request may close these issues.

1 participant