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

Template update #538

Merged
merged 4 commits into from Nov 26, 2019
Merged

Template update #538

merged 4 commits into from Nov 26, 2019

Conversation

flicstar
Copy link
Collaborator

Removed the uDig content. Made changes in line with my learnings so far and now it should be a companion to the wiki page: https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file

@flicstar
Copy link
Collaborator Author

Updated after reading @camerons review on the 'How to' page of the wiki

@camerons
Copy link
Contributor

Minor comments to be addressed separately to this pull request:

  • Inconsistent use of "Quickstart and Quick Start". To date, we have mostly been using "Quickstart"
  • When I run "make" in OSGeoLive docs, the _template_quickstart is not being created as HTML, so I can't see the created template as HTML. Ideally, we should be able to see it. I think this might require adding the _template to the projects.csv file, (which likely has bad side effects, like the template might become a full project). Something to discuss later.
  • It is hard to find how to build the OSGeoLive docs from our wiki: https://trac.osgeo.org/osgeolive/wiki . Details are found in git: https://github.com/OSGeo/OSGeoLive-doc . This is something to update as a link in our wiki pages.
  • Re: "Writing Tip: Optionally, include a screenshot here of the UI."
    ** I don't consider images as Optional. While we don't need one for every step, we do need as many images as the user is about to experience. A user should be able to read the quickstart without running it, and understand from the screenshots what would have happened if running themselves.
    ** Suggest expand accronyms like "UI" to User Interface.

@camerons camerons merged commit ae708db into OSGeo:master Nov 26, 2019
@flicstar flicstar deleted the template branch January 22, 2020 00:37
@cvvergara cvvergara added this to the Release 14.0.0 milestone Aug 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants