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

geoconnect documentation guide #3643

Closed
raprasad opened this issue Feb 22, 2017 · 14 comments
Closed

geoconnect documentation guide #3643

raprasad opened this issue Feb 22, 2017 · 14 comments

Comments

@raprasad
Copy link
Contributor

raprasad commented Feb 22, 2017

The guide should include some of the info in the geconnect wiki:

There's a diagram at #3495 (comment)

@raprasad
Copy link
Contributor Author

raprasad commented Apr 6, 2017

Add this gist info about switching geoconnect servers:

https://gist.github.com/raprasad/4f65e67a392e4ec0b3975a0b3597627a

@pdurbin
Copy link
Member

pdurbin commented Apr 11, 2017

I just discovered that there is a ton of end user documentation already at http://worldmap.harvard.edu/static/docs/WorldMap_Help_en.pdf which is linked from http://worldmap.harvard.edu as "Need Help?" Here's a screenshot:

screen shot 2017-04-11 at 12 42 48 pm

We should at least link to this resource. Right now http://guides.dataverse.org/en/4.6.1/user/data-exploration/worldmap.html is quite sparse and there are no screenshots.


Update: see also this issue I opened: WorldMap Help PDF is out of date with regard to production bug in Harvard Dataverse · Issue #227 · cga-harvard/cga-worldmap

@djbrooke djbrooke added the ready label Apr 18, 2017
@dlmurphy dlmurphy self-assigned this Apr 19, 2017
@dlmurphy
Copy link
Contributor

dlmurphy commented Apr 20, 2017

@raprasad The gist info you linked in your earlier comment seems like it'd fit more in the Installation Guide than the User Guide. Does this ticket include both, or am I focusing only on the User Guide?

Edit: Checked in on this, this ticket includes both.

@mheppler mheppler self-assigned this Apr 20, 2017
dlmurphy added a commit that referenced this issue Apr 21, 2017
Initial commit so that @mheppler can come on board this branch. This is
a totally unfinished rough draft of half of the Geoconnect user guide.
@mheppler
Copy link
Contributor

@mheppler
Copy link
Contributor

Added Geoconnect info to Admin, Developers and Installation guides. Reviewing with team.

dlmurphy referenced this issue Apr 24, 2017
Finished user guide page for GeoConnect, including screenshots to help
guide users through the mapping process.
@dlmurphy
Copy link
Contributor

dlmurphy commented Apr 24, 2017

Added user guide for Geoconnect. Awaiting review by @raprasad to ensure that I got all the technical details correct.

dlmurphy added a commit that referenced this issue Apr 24, 2017
Misc typo, grammar, formatting fixes.
dlmurphy added a commit that referenced this issue Apr 24, 2017
@dlmurphy
Copy link
Contributor

dlmurphy commented Apr 24, 2017

I just finished proofreading the Admin, Developer, and Installation guides. Lookin' good!

@raprasad
Copy link
Contributor Author

Notes for admin, installation, and developer guides: https://gist.github.com/raprasad/a0bf36cd08ece1b282eb14ce0ba2a9b2

@pdurbin pdurbin removed their assignment Apr 25, 2017
@raprasad
Copy link
Contributor Author

dlmurphy added a commit that referenced this issue Apr 25, 2017
Phrasing and syntax improvements based on Raman's review of the
geoconnect user guide.
@pdurbin pdurbin self-assigned this Apr 26, 2017
pdurbin added a commit that referenced this issue Apr 26, 2017
- Explain that we don't recommend sysadmins to install Geoconnect at
  this time.
- For User Guide page, add table of contents (exposed improper nesting,
  also fixed) and explain that Geoconnect is optional.
- Various other tweaks, fixes, and improvements.
@pdurbin
Copy link
Member

pdurbin commented Apr 26, 2017

I just made some improvements in aea9ccf and left a review in pull request #3792 but I'll repeat the feedback here.

Great work. Much improved from what's in production now.

User Guide

What percentage of users are going to be viewing maps versus creating them? My guess is that more people will be viewing maps since you don't even need to create a Dataverse account to view a map. You just click the button on the dataset or file page. Given this, before we even talk about creating maps, can we have a short section on viewing maps?

Maybe some tips on finding maps to look at as well.

Admin Guide

In the Geoconnect README we say, "You should wait until the WorldMap rewrite is complete before considering installing Geoconnect." Should we explain on this page that people installing Dataverse are welcome to use the two servers below that are hosted by Harvard?

Dev Guide

All of this detail here and below about Geoconnect is great but I'm thinking we should have a separate page for it. This page is getting long and the focus should be about setting up a development environment, not a relatively deep dive into a specific feature. I would suggest following the pattern established by UNF, which is even split into multiple pages:

I don't think we want all that detail about UNF on this "Development Environment" page.

@pdurbin pdurbin removed their assignment Apr 26, 2017
@pdurbin
Copy link
Member

pdurbin commented Apr 26, 2017

I ran a build so you can see my changes immediately at http://guides.dataverse.org/en/3643-geoconnect-guide/user/data-exploration/worldmap.html but builds continue to run every hour.

dlmurphy added a commit that referenced this issue Apr 26, 2017
Added a short paragraph explaining how to view a map, per @pdurbin's
suggestion
@dlmurphy dlmurphy removed their assignment Apr 26, 2017
pdurbin added a commit that referenced this issue Apr 26, 2017
mheppler added a commit that referenced this issue Apr 26, 2017
mheppler added a commit that referenced this issue Apr 26, 2017
@mheppler
Copy link
Contributor

Revisions to Geoconnect documentation in Developer Guide, moved most info into new Geospatial Data pg.

@mheppler mheppler removed their assignment Apr 26, 2017
@pdurbin
Copy link
Member

pdurbin commented May 1, 2017

@dlmurphy thanks for corresponding with @bglewis about the WorldMap PDF at cga-harvard/geonode#227

@kcondon kcondon self-assigned this May 1, 2017
@kcondon kcondon closed this as completed May 1, 2017
@kcondon kcondon removed the Status: QA label May 1, 2017
@pdurbin pdurbin added the Type: Feature a feature request label May 18, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants