Skip to content

Update dev docs #11513

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

Merged
merged 30 commits into from
Sep 8, 2021
Merged

Update dev docs #11513

merged 30 commits into from
Sep 8, 2021

Conversation

tcmetzger
Copy link
Member

@tcmetzger tcmetzger commented Aug 15, 2021

This PR supersedes #11418 and collects my updates to the developer docs. Instead of trying to have all updates in one PR, I'm trying to split up the work to make it more manageable. This PR contains the following updated/new chapters:

  • Landing page
  • Contributing to the documentation
  • Running tests
  • Writing tests
  • Creating issues
  • Creating a successful pull request

The following three chapters will be updated in subsequent pull requests: "Working with Bokeh models", "Understanding Bokeh server", "Contributing to BokehJS". These three chapters are currently in their original state, with only small changes to adapt to the new structure. This way, the developer docs remain complete and functional, even before merging any subsequent PRs.

Fixes #11354

@tcmetzger tcmetzger added this to the 2.4 milestone Aug 15, 2021
@tcmetzger tcmetzger self-assigned this Aug 15, 2021
@tcmetzger
Copy link
Member Author

Currently, all filenames (rst) are unchanged to make sure we don't get any dead links. Files that are no longer needed (such as bindings.rst that is now included in the landing page) still exist but contain a link to the new location of the content, together with :orphan:.

@tcmetzger
Copy link
Member Author

tcmetzger commented Sep 6, 2021

I've added all suggestions and labeled this PR as ready. After the 2.4 release, I'll work on the remaining chapters (Models, Server, and BokehJS), and can also add more improvements to the chapters in this PR.
(The BkoehJS test failure on CI for macOS seems unrelated to my changes)

@mattpap
Copy link
Contributor

mattpap commented Sep 6, 2021

Test failures are unrelated and will by resolved by PR #11566.

@tcmetzger
Copy link
Member Author

tcmetzger commented Sep 7, 2021

I have updated the PR based on Mateusz' feedback. As mentioned above, the CI failures for macOS/windows are not related to my changes.

@bryevdv
Copy link
Member

bryevdv commented Sep 7, 2021

Unfortunately I only had time to skim this morrning. One type and one small comment for consideration, otherwise LGTM

@bryevdv bryevdv merged commit 6500c82 into branch-2.4 Sep 8, 2021
@bryevdv bryevdv deleted the timo/11354_update_dev_docs branch September 8, 2021 02:13
bryevdv pushed a commit that referenced this pull request Dec 13, 2021
* Add sphinx tabs

* Update dev docs

* Add section on issues

* Link from BokehJS to new testing chapters

* Add section on pull requests

* Add remaining chapters (WIP)

* Update TOC

* General edits

* Update "writing tests"

* Fix links

* Update section on code coverage

* List more options for BOKEH_RESOURCES

* Update test sections

* Update issues and PR sections

* Updates

* Update details for testing

* Update documentation for pre-commit

* Add details on pre-commit

* Update writing tests section

* Update documentation section

* Update links in footer, etc.

* Make anchor names consistent

* Fix line lengths

* Add info an assert

* Update wording for consistency

* Update section on BokehJS unit test

* Fix Typos

* Update documentation.rst
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Selenium unit tests fail on Ubuntu locally Update developer docs
3 participants