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

Reviewed geoext QuickStart #526

Merged
merged 6 commits into from Nov 27, 2019
Merged

Reviewed geoext QuickStart #526

merged 6 commits into from Nov 27, 2019

Conversation

flicstar
Copy link
Collaborator

@flicstar flicstar commented Nov 13, 2019

Reviewed as part of the QuickStart project during Google Season of Docs 2019. The aim is consistency across all OSGeoLive QuickStarts. Also see PR 498 #498

The document is structured well and only requires minor changes.

@geographika Please action comments and suggestions you agree with, and ignore those you don't.

Partner trac ticket link: https://trac.osgeo.org/osgeolive/ticket/2195

See this page for reference: https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file

@geographika
Copy link
Contributor

@flicstar - changes look good. A few comments:

  • The underlining for subtitles / headings needs to be the same length or Sphinx gives warnings. E.g.
Create an HTML Page
---------

doc\quickstart\geoext_quickstart.rst:24: WARNING: Title underline too short.

  • In terms of styling, should all subheadings be in title case? E.g. "Configure OpenLayers objects" should be "Configure OpenLayers Objects". This is currently inconsistent.

  • Sphinx allows autoenumerated lists/steps of paragraphs using # - see here. Should these be recommended or avoided? It helps keeps the numbering correctly ordered, but writers need to know the syntax.

@flicstar
Copy link
Collaborator Author

Thanks @geographika I update the heading markup and also made them title case. I think my preference is for sentence case but sometimes it's hard for me to know which things are proper nouns and so require capitalization. Also the 'What Next' at the end does look better as title case and consistency is important.
In terms of the numbering, I tried to always use the hash symbol except for when I found that if a procedure had anything nested like code blocks or images, it tended to restart at 1 in the middle of a procedure.

@geographika
Copy link
Contributor

@flicstar - see flicstar#1
With regards to the numbering - any code or image blocks have to be indented in line with the start of the text after the numbering - so typically 3 spaces to match #.

@flicstar flicstar changed the title Reviewed geoext QuickStart @flicstar (Season of Docs 2019) Reviewed geoext QuickStart Nov 18, 2019
ensure you have permissions to save the file open Leafpad from the command line with elevated permissions using the
In this step we will set-up an empty HTML page which will contain the application. We'll use the text editor Leafpad installed on OSGeoLive to create a new HTML file at ``/var/www/html/geoext/demo.html``

#. Open Leafpad from the command line with elevated permissions (so you can save the file) using the
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@geographika Any idea why these "numbers" are displaying as hash symbols rather than numbers? Argh! I can see your tip about indenting the codeblocks has worked in the later sections, thanks!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@flicstar - see flicstar#2 - the text also has to be aligned with the block.

@flicstar
Copy link
Collaborator Author

http://irclogs.geoapt.com/osgeolive/%23osgeolive.2019-11-26.log

20:14:30 sethg: "mapserver, mapcache, geoext can all be considered approved"

@flicstar flicstar merged commit 373a2eb into OSGeo:master Nov 27, 2019
@flicstar flicstar deleted the geoext branch November 27, 2019 04:33
@cvvergara cvvergara mentioned this pull request Aug 19, 2020
@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