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

META - Documentation improvements (infra and workflows) #397

Closed
11 tasks done
pavithraes opened this issue Oct 20, 2022 · 6 comments
Closed
11 tasks done

META - Documentation improvements (infra and workflows) #397

pavithraes opened this issue Oct 20, 2022 · 6 comments
Assignees
Labels
area: documentation 📖 Improvements or additions to documentation area: user experience 👩🏻‍💻 Items impacting the end-user experience status: in progress 🏗

Comments

@pavithraes
Copy link
Member

pavithraes commented Oct 20, 2022

Docusaurus allows us to create landing pages, and provides a nice visual and functional user experience for the docs. For example, see Nebari docs update: https://www.nebari.dev/

From Tania:

If we move to Docusaurus we could even add the Storybook Docusaurus addon to keep all our docs in a single place


Tasks

Preview Give feedback
  1. area: documentation 📖 type: enhancement 💅🏼
    pavithraes
  2. area: documentation 📖 needs: discussion 💬
    kcpevey
  3. pavithraes trallard
@pavithraes pavithraes added area: documentation 📖 Improvements or additions to documentation needs: discussion 💬 This item needs team-level discussion before scoping labels Oct 20, 2022
@costrouc
Copy link
Member

@pavithraes I am open to this but do appreciate the "simplicity" of sphinx. I feel this would be a lot of work to make that transition. That said I do think that the docusuarus generated pages are much nicer.

@trallard trallard moved this from New 🚦 to TODO 📬 in conda-store 🐍 Jul 26, 2023
@trallard
Copy link
Collaborator

If we move to Docusaurus we could even add the Storybook Docusaurus addon to keep all our docs in a single place

@trallard trallard added the area: user experience 👩🏻‍💻 Items impacting the end-user experience label Jul 26, 2023
@trallard trallard added this to the 🚀 JATIC - Q1 milestone Aug 1, 2023
@trallard trallard moved this from New 🚦 to TODO 📬 in conda-store 🐍 Aug 1, 2023
This was referenced Aug 8, 2023
@pavithraes pavithraes moved this from TODO 📬 to In Progress 🏗 in conda-store 🐍 Aug 8, 2023
@trallard trallard changed the title Move documentation to Docusaurus META - Documentation improvements (infra and workflows) Aug 22, 2023
@costrouc
Copy link
Member

@pavithraes clould you write a status update on this?

@costrouc
Copy link
Member

@smeragoel asked if it is possible to document design here as well?

@pavithraes
Copy link
Member Author

@costrouc - this work was on hold for a while, picking it up this week. :)

@smeragoel asked if it is possible to document design here as well?

I don't fully understand the question here, could you please elaborate on this @smeragoel?
In case you mean should we track it here -- there is a task for design doc in #561 (tracking the actual content there) and the placeholder page is: https://github.com/conda-incubator/conda-store/blob/main/docusaurus-docs/community/design.md

@pavithraes
Copy link
Member Author

I'm going to mark this META issue as complete. We do have the playwright tests task remaining, but we can track that in the corresponding issue. :)

@github-project-automation github-project-automation bot moved this from In Progress 🏗 to Done 💪🏾 in conda-store 🐍 Jan 30, 2024
@github-project-automation github-project-automation bot moved this from TODO 📬 to Done 💪🏾 in conda-store 🐍 Jan 30, 2024
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 status: in progress 🏗
Projects
Archived in project
Development

No branches or pull requests

3 participants