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

DOC: added all projects toctree to databroker #321

Merged
merged 3 commits into from
Aug 2, 2019

Conversation

mrakitin
Copy link
Member

@mrakitin mrakitin commented Dec 7, 2017

Description

Add all projects toctree to the databroker documentation.

Motivation and Context

Motivated by NSLS-II/docs#73.

How Has This Been Tested?

Tested locally by building the documentation.

@codecov-io
Copy link

codecov-io commented Dec 7, 2017

Codecov Report

❗ No coverage uploaded for pull request base (master@6e1dad0). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #321   +/-   ##
=========================================
  Coverage          ?   83.11%           
=========================================
  Files             ?       50           
  Lines             ?     6355           
  Branches          ?      922           
=========================================
  Hits              ?     5282           
  Misses            ?      943           
  Partials          ?      130

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6e1dad0...2c70ac2. Read the comment docs.

@mrakitin mrakitin requested a review from danielballan January 11, 2018 16:15
@jrmlhermitte
Copy link
Contributor

this looks good to me (and I'm trusting that it builds when you say it does)
@danielballan is this good to go?

@danielballan
Copy link
Member

Let's get Travis's BUILD_DOCS build to pass before we merge. I just kicked it to re-run. Merge at will if/when it passes.

@mrakitin
Copy link
Member Author

Probably it needs rebasing and manual resolution of the conflict.

@tacaswell tacaswell added this to the 0.13 milestone Dec 20, 2018
@danielballan
Copy link
Member

I think we should revisit whether and how to do this. The number of packages is growing large. Instead of linking to them all, maybe just link to blueskyproject.io? What do you think, @mrakitin?

@mrakitin
Copy link
Member Author

I agree with that approach.

@mrakitin mrakitin force-pushed the doc_toctree_everywhere branch from 44959b4 to 2c70ac2 Compare July 30, 2019 15:38
@mrakitin
Copy link
Member Author

I rebased on master and changed all the project documentation links to a single URL. Does it make sense, @danielballan?

@danielballan
Copy link
Member

Thanks! Do you think we should remove the NSLS-II link as well, just to give the right impression? And maybe replace BugReports with the gitter, which is probably a better first place to go for help?

@mrakitin
Copy link
Member Author

It's available via 560185a.

:hidden:
:caption: Getting Help

Gitter <https://gitter.im/NSLS-II/DAMA>
Copy link
Member

Choose a reason for hiding this comment

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

Actually --- In the spirit of scrubbing facility-specific branding out, should we move to a bluesky gitter? The way projects do this (e.g. jupyterlab moved from jupyter/jupyterlab -> jupyterlab/jupyterlab) is to post a big message in the gitter with a link to the new one. There is no way to set up an actual redirect.

Copy link
Member

Choose a reason for hiding this comment

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

If this were mainly an NSLS-II support channel I would say we should leave it as is, but it seems that a fair fraction of the questions we get are from other facilities that are evaluating bluesky.

Copy link
Member

Choose a reason for hiding this comment

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

I agree

Copy link
Member

@stuartcampbell stuartcampbell left a comment

Choose a reason for hiding this comment

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

I think moving the gitter to a non NSLS-II would be good, but we can always do that in a follow on PR if we want to merge this one now and then go off and investigate the best way to deal with Gitter.

:hidden:
:caption: Getting Help

Gitter <https://gitter.im/NSLS-II/DAMA>
Copy link
Member

Choose a reason for hiding this comment

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

I agree

@danielballan
Copy link
Member

Good enough for me. We might want to resolve the gitter question before we update all the repos though, to save effort.

@danielballan danielballan merged commit cebed19 into bluesky:master Aug 2, 2019
@mrakitin mrakitin deleted the doc_toctree_everywhere branch August 21, 2019 14:14
@mrakitin mrakitin modified the milestones: 0.13, 0.13.3 Aug 21, 2019
gwbischof pushed a commit to gwbischof/databroker that referenced this pull request Jan 8, 2020
DOC: added all projects toctree to databroker
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.

6 participants