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

[WIP] Major revamp of documentation #196

Merged
merged 12 commits into from
Apr 21, 2020
Merged

Conversation

Zsailer
Copy link
Member

@Zsailer Zsailer commented Mar 24, 2020

I'm in the middle of adding a bunch of documentation to Jupyter Server. Opening now to get the PR in place for merging.

Taking @kevin-bates's suggestion, I've started by separating the documentation into the following roles/personas—1) Users 2) Operators 3) Developers and 4) Contributors

I'm also planning to add a FAQ section to route readers to the appropriate page based on their questions.

This is rebased on #180. I'm hoping we can merge that soon, then this PR can go in.

docs/source/conf.py Outdated Show resolved Hide resolved
@Zsailer
Copy link
Member Author

Zsailer commented Apr 21, 2020

I'm done with the docs for now. I'd like to merge this as-is. We can iterate and edit in future PRs.

@Zsailer Zsailer merged commit 4a2d8e3 into jupyter-server:master Apr 21, 2020
@Zsailer Zsailer mentioned this pull request Apr 21, 2020
hMED22 pushed a commit to hMED22/jupyter_server that referenced this pull request Jan 23, 2023
* Docs WIP

* add user docs

* start operator docs

* [wip] more docs

* rearrage some developer docs

* more docs

* update readme

* switch to pydata theme

* minor changes to docs

* update extending docs

* update docs

* minor typo
@Zsailer Zsailer deleted the docs branch January 16, 2024 21:47
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.

3 participants