Describe how to install and run the rpc-serve from the
popular-3k-python dataset.
Details
Details
- Reviewers
seirl zack - Maniphest Tasks
- T2530: Write a simple "quick start" for swh-graph
- Commits
- rDGRPH8c937da20785: Add a short `quickstart` guide
Diff Detail
Diff Detail
- Repository
- rDGRPH Compressed graph representation
- Branch
- master
- Lint
Lint Skipped - Unit
Unit Tests Skipped - Build Status
Buildable 14896 Build 22954: Phabricator diff pipeline on jenkins Jenkins console · Jenkins Build 22953: arc lint + arc unit
Event Timeline
Comment Actions
Build is green
Patch application report for D3871 (id=13663)
Rebasing onto 2bbfbd8500...
Current branch diff-target is up to date.
Changes applied before test
commit a849a25aef0588677d6e9a280e9a0e977beb2a40
Author: David Douard <david.douard@sdfa3.org>
Date: Thu Sep 3 14:29:08 2020 +0200
Add a short `quickstart` guide
Describe how to install and run the `rpc-serve` from the
`popular-3k-python` dataset.See https://jenkins.softwareheritage.org/job/DGRPH/job/tests-on-diff/18/ for more details.
Comment Actions
Thanks, this looks good!
Apart from minor nitpicks, my only concern here is that it might not be 100% clear who this doc is addressing. I reckon that people clicking on the "quickstart" page of swh.graph can come from different situations:
- people who want to use swh-graph without any consideration for the rest of the SWH infrastructure on an arbitrary graph (what you seem to have written here)
- people who want to install swh-graph as part of their SWH development environment
- people who would like to run topology experiments on our graph but have no idea where to start
- ...
In that regard, I am not sure "quickstart" is appropriate here -- but I really don't have a better idea of how this doc should be written. I am okay for merging that as-is until we figure out what we want to show potential users. Maybe @zack would like to chime in here?
I guess it would probably be a good idea to at least start with an intro paragraph about what we're trying to achieve in this tutorial?
| docs/quickstart.rst | ||
|---|---|---|
| 18 | default-jre to avoid pinning the version? | |
| 82 | I'd use curl here since it's more likely to be already installed and that we don't/can't use any of the interesting httpie features, so it's just acting as curl here. ymmv | |
Comment Actions
I agree this needs to be addressed. But let's start by having something then improve it :-)
(Thx for the tips)
Comment Actions
Build is green
Patch application report for D3871 (id=13670)
Rebasing onto 2bbfbd8500...
Current branch diff-target is up to date.
Changes applied before test
commit bf5146a07ae759b298ab23868c92e316f277ac3d
Author: David Douard <david.douard@sdfa3.org>
Date: Thu Sep 3 14:29:08 2020 +0200
Add a short `quickstart` guide
Describe how to install and run the `rpc-serve` from the
`popular-3k-python` dataset.See https://jenkins.softwareheritage.org/job/DGRPH/job/tests-on-diff/19/ for more details.
Comment Actions
Build is green
Patch application report for D3871 (id=13672)
Rebasing onto 2bbfbd8500...
Current branch diff-target is up to date.
Changes applied before test
commit 9fb92dc5574be213a5e8f0313a5d9af49818b6bb
Author: David Douard <david.douard@sdfa3.org>
Date: Thu Sep 3 14:29:08 2020 +0200
Add a short `quickstart` guide
Describe how to install and run the `rpc-serve` from the
`popular-3k-python` dataset.See https://jenkins.softwareheritage.org/job/DGRPH/job/tests-on-diff/20/ for more details.
Comment Actions
Build is green
Patch application report for D3871 (id=13708)
Rebasing onto 0295a3be94...
Current branch diff-target is up to date.
Changes applied before test
commit 8c937da20785699ae2a0a604104a9e458eced201
Author: David Douard <david.douard@sdfa3.org>
Date: Thu Sep 3 14:29:08 2020 +0200
Add a short `quickstart` guide
Describe how to install and run the `rpc-serve` from the
`popular-3k-python` dataset.See https://jenkins.softwareheritage.org/job/DGRPH/job/tests-on-diff/23/ for more details.