Documentation Review - Githubissues

jupyterlab / jupyterlab-metadata-service

Linked data exploration in JupyterLab.

BSD 3-Clause "New" or "Revised" License

29 stars 16 forks source link

Documentation Review #48

Closed Zsailer closed 4 years ago

Zsailer commented 4 years ago

(Sorry for the delay on this, @saulshanabrook!)

I'll add some items to this checklist as I go. I'll submit PRs too :)

[ ] Developer docs jupyterlab extension link ... command point to outdated paths.
- ../jupyterlab-data-explorer/dataregistry-extension/ becomes ../jupyterlab-data-explorer/packages/dataregistry-extension/
- ../jupyterlab-data-explorer/dataregistry/ becomes ../jupyterlab-data-explorer/packages/dataregistry/

saulshanabrook commented 4 years ago

Ah thanks! Yeah that was a pretty recent change. This won't even work at the moment with the new packages I believe.

Zsailer commented 4 years ago

Ah, you're right! I had to install the dev version using the contributing docs on the data-explorer.

saulshanabrook commented 4 years ago

We should probably change the docs here to not use the dev version of the data explorer, instead just use the published version, like this:

https://github.com/jupyterlab/jupyterlab-metadata-service/blob/a7387c05ab5c8999f9cacd4a485af84fe26f31f5/.github/workflows/test.yml#L16

saulshanabrook commented 4 years ago

@kgryte at some point we should publish the new packages from the data registry and update this to depend on them. I guess until then we can just remove the instructions for installing both from master and just use the release version of the data registry?

kgryte commented 4 years ago

Agreed.

kgryte commented 4 years ago

Also, presumably, we should only be encouraging contributors to be working off the release version anyway, as this is what this extension depends on.

kgryte commented 4 years ago

Submitted a PR to address the setup instructions: https://github.com/jupyterlab/jupyterlab-metadata-service/pull/50