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

adding repoproviders documentation #1017

Merged
merged 7 commits into from
Dec 5, 2019
Merged

Conversation

choldgraf
Copy link
Member

This is a documentation update for repository providers, it does these main things:

  1. Updates our table of repoprovider specs to include recent additions
  2. Adds a new page dedicated to repository providers, and moves a section of the API docs there (with the goal of making this information more discoverable)
  3. Adds a section on adding a new repository provider, so it's easier to
    provide guideance on PRs like Add Dataverse to UI. Fixes #900 #969

What do folks think?

and modifying a set of methods/attributes to interface with the online
provider to which you are providing access.

In order to extend the supported repository providers,
Copy link
Member

Choose a reason for hiding this comment

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

Should we add a step that it is highly likely that your first step would be to add a new content provider to repo2docker?

Co-Authored-By: Tim Head <betatim@gmail.com>
@choldgraf
Copy link
Member Author

accepted your comments and added a note about content providers. I also realized we don't have a similar section for how to add a new content provider in the repo2docker docs, so I opened jupyterhub/repo2docker#823 too

@nuest
Copy link
Contributor

nuest commented Dec 3, 2019

I re-visited a repo provider I've added (see #951) and found that I had to make changes to binderhub/static/js/index.js for the example text and binderhub/templates/index.html for the dropdown entry. AFAICS that's missing from the steps.

[ The JS file reminds me of the need for a proper API to generate the UI... still very good to document the current state though! ]

@choldgraf
Copy link
Member Author

@nuest aren't both of those addressed here: https://github.com/jupyterhub/binderhub/pull/1017/files#diff-cbeb18fbf4548b84e49c010cf02f439dR57 ? Let me know if I'm missing something!

(and I totally agree about the need to do less hard-coding etc)

@nuest
Copy link
Contributor

nuest commented Dec 4, 2019

@choldgraf My bad, those files are indeed included in that changeset!

@choldgraf
Copy link
Member Author

anything else to do here? If we can get this in then we'll ask #967 and #969 to document themselves and then we can get those merged too

@choldgraf
Copy link
Member Author

I thought about it a bit more and decided to add repository provider information to the table, the new version is here:

https://643-89419368-gh.circle-artifacts.com/0/html/developer/repoproviders.html#supported-repoproviders

@betatim
Copy link
Member

betatim commented Dec 5, 2019

Merging this now. We can keep tweaking it in a new PR.

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