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.

Sign up for GitHub

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

Jump to bottom

[DOC]: README Update #908

Closed
jarmak-nv opened this issue Feb 8, 2023 · 0 comments · Fixed by #977
Closed

[DOC]: README Update #908

jarmak-nv opened this issue Feb 8, 2023 · 0 comments · Fixed by #977
Assignees
@jarmak-nv
Labels
doc Documentation

Comments

@jarmak-nv
Copy link
Contributor

How would you describe the priority of this documentation request

Medium

Is this for new documentation, or an update to existing docs?

Update

Describe the incorrect/future/missing documentation

cuSpatial has grown significantly over the past ~10 months and focused on a specific direction. Our Readme should be updated to reflect the state of cuSpatial today and to be more relevant as more users find our page.

If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.

No response
@jarmak-nv jarmak-nv added doc Documentation Needs Triage Need team to review and classify labels Feb 8, 2023
@jarmak-nv jarmak-nv self-assigned this Feb 8, 2023
@github-project-automation github-project-automation bot moved this to Todo in cuSpatial Feb 8, 2023
@jarmak-nv jarmak-nv removed the Needs Triage Need team to review and classify label Feb 8, 2023
@jarmak-nv jarmak-nv mentioned this issue Mar 7, 2023
Merged
9 tasks
@jarmak-nv jarmak-nv moved this from Todo to In Progress in cuSpatial Mar 8, 2023
@jarmak-nv jarmak-nv moved this from In Progress to Review in cuSpatial Mar 9, 2023
@jarmak-nv jarmak-nv moved this from Review to Blocked in cuSpatial Mar 17, 2023
@jarmak-nv jarmak-nv mentioned this issue Mar 17, 2023
Merged
3 tasks
rapids-bot bot pushed a commit that referenced this issue Mar 20, 2023
@jarmak-nv
: Move build instructions to dev guide (#999)
1728738 
Contributes to #908 and unblocks #977 

This PR moves the existing build from source instructions to the developer docs page. It does not make any changes to the instructions.

Authors:
  - Ben Jarmak (https://github.com/jarmak-nv)

Approvers:
  - H. Thomson Comer (https://github.com/thomcom)
  - Michael Wang (https://github.com/isVoid)

URL: #999
@jarmak-nv jarmak-nv moved this from Blocked to Review in cuSpatial Mar 21, 2023
@rapids-bot rapids-bot bot closed this as completed in #977 Mar 21, 2023
rapids-bot bot pushed a commit that referenced this issue Mar 21, 2023
@jarmak-nv
Update cuSpatial Readme (#977)
9aa3ee2 
Closes #908 

With all of the development on cuSpatial, it's time for a new README that is both more up-to-date, and more aligned with other RAPIDS READMEs.
### Outstanding tasks
- [x] Add function hyperlinks
- [x] Move `build from source` instructions to developer docs
  - [x] Remove from readme
  - [x] #999
- [x] Consider adding visuals for things like distances using [GitHub topojson](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams#creating-geojson-and-topojson-maps)
- [x] #987

Authors:
  - Ben Jarmak (https://github.com/jarmak-nv)

Approvers:
  - H. Thomson Comer (https://github.com/thomcom)
  - Mark Harris (https://github.com/harrism)
  - Michael Wang (https://github.com/isVoid)

URL: #977
@github-project-automation github-project-automation bot moved this from Review to Done in cuSpatial Mar 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jarmak-nv jarmak-nv

Labels
doc Documentation
Projects
cuSpatial
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[DOC] Update cuSpatial Readme jarmak-nv/cuspatial
1 participant
@jarmak-nv