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

Compile list of features from subprojects #7

Open
chbrandt opened this issue Oct 11, 2023 · 4 comments
Open

Compile list of features from subprojects #7

chbrandt opened this issue Oct 11, 2023 · 4 comments

Comments

@chbrandt
Copy link
Collaborator

I understand one of the tasks we have is to map (somehow) the documentation across the subprojects, so we can understand their structure and processes. One of the information we want to collect is good/nice/working features (eg, best practices) in the subprojects.

@RRosio
Copy link
Collaborator

RRosio commented Oct 19, 2023

I'd like to add the JupyterHub Documentation whose structure follows the Diátaxis Framework. The JupyterCon 2023 Presentation, Sarah Gibson, Allan Wasega Restructuring and Improving JupyterHub Documentation Using the Diátaxis Framework, was my introduction to the framework and the work done by the JupyterHub team.

@ericsnekbytes
Copy link
Collaborator

During the JupyterHub weekly, we discussed items to borrow from them, and this template was brought up as a good example of providing "starting resources" to contributors.

https://github.com/jupyterhub/jupyterhub-python-repo-template

@chbrandt
Copy link
Collaborator Author

Documentation template by JupyterHub:

https://github.com/jupyterhub/jupyterhub-sphinx-theme

@chbrandt
Copy link
Collaborator Author

chbrandt commented May 2, 2024

A bit off-topic, but in the spirit of good practices or important aspects of OSS contributions and sustainability:

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

No branches or pull requests

3 participants