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

Set up Docusaurus #534

Merged
merged 14 commits into from
Aug 15, 2023
Merged

Set up Docusaurus #534

merged 14 commits into from
Aug 15, 2023

Conversation

pavithraes
Copy link
Member

@pavithraes pavithraes commented Aug 8, 2023

Addresses #397

Set up the Docusaurus skeleton and a documentation structure. Took a lot of inspiration from the nebari setup: nebari.dev

Note:

  • We'll have two sets of docs for a little while, and we can remove the sphinx docs once all pages are migrated.
  • Added some blank docs pages to see if the diataxis structure works and I think it does; won't be committing them, will open new issues to track the work.

Preview:

Screen.Recording.2023-08-11.at.5.45.15.AM.mov

@pavithraes pavithraes added area: documentation 📖 Improvements or additions to documentation status: in progress 🏗 impact: high 🟥 This issue affects most of the conda-store users or is a critical issue project: JATIC Work item needed for the JATIC project area: user experience 👩🏻‍💻 Items impacting the end-user experience labels Aug 8, 2023
@pavithraes pavithraes self-assigned this Aug 8, 2023
@pavithraes pavithraes changed the title [WIP] Move to Docusaurus Set up Docusaurus Aug 11, 2023
@pavithraes pavithraes marked this pull request as ready for review August 11, 2023 00:10
@pavithraes
Copy link
Member Author

This is ready for initial feedback, note that the setup isn't polished and needs some clean-up

@trallard
Copy link
Collaborator

trallard commented Aug 11, 2023

Considering we have both conda-store and conda-store-ui content there, should we have two different items on the navbar: conda-store (docs?) conda-store-ui and present these as almost independent docs sections (see the conda-forge WIP docs for an example https://cf-infra-docs.netlify.app/docs/)

Actually we could also separate the community section into another sidebar (thought about this for nebari too) as the main sidebar can grow a lot and hide the sections

@trallard
Copy link
Collaborator

Following up since I forgot to ask - shall we add Netlify here so we can get website previews?

I find it really useful when reviewing PRs and making changes to the website as some settings/features are slightly different when developing locally and in "production" mode within Docusaurus.

Copy link
Collaborator

@trallard trallard left a comment

Choose a reason for hiding this comment

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

I left a couple of minor comments, overall all looks good and I would like to get this merged ASAP so we can start iterating on this.
Will approve and if you get those minor changes in you can merge @pavithraes

docusaurus-docs/README.md Outdated Show resolved Hide resolved
docusaurus-docs/docs/contribute/traige.md Outdated Show resolved Hide resolved
@pavithraes
Copy link
Member Author

pavithraes commented Aug 15, 2023

@trallard Thanks for your review and suggestions!

I've moved your comments(#534 (comment) and #534 (comment)) to corresponding issues where we can address them individually.

I'll merge this PR with the blank files so that we have files to re-arrange to test the multi-instance setups (i.e., separate community docs, etc.).

@pavithraes pavithraes merged commit 8425069 into conda-incubator:main Aug 15, 2023
8 checks passed
@pavithraes pavithraes deleted the docusaurus branch November 14, 2023 12:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation 📖 Improvements or additions to documentation area: user experience 👩🏻‍💻 Items impacting the end-user experience impact: high 🟥 This issue affects most of the conda-store users or is a critical issue project: JATIC Work item needed for the JATIC project status: merge ready 🚀
Projects
Status: Done 💪🏾
Development

Successfully merging this pull request may close these issues.

2 participants