Porting OpenGrid documentation to new docs template

[tomschenkjr]

This work is based on internal rewriting of the sister-project, WindyGrid, which substantially improved the quality of documentation.

Use the WindyGrid documentation template. Any instructions/documentation that are the same between WindyGrid and OpenGrid should remain the same and unchanged.

Items which are unique to OpenGrid should be added as individual sections so they can be easily removed or inserted between WindyGrid and OpenGrid docs.

Instructions on using OpenGrid should be on a separate tab (see example) than setting-up and administering OpenGrid. The user instructions should appear on the first tab.

[reve0716]

The porting has been completed waiting to overview @tomschenkjr and push over to production.

[tomschenkjr]

I'm reviewing http://docs.opengrid.io/en/dev/ and see the OpenGrid logo on the front page is broken. Can you fix that?

[reve0716]

The updates are being blocked by a failed build. I'm checking into it.

[reve0716]

The links in the index file is broken (OpenGrid's API and Service Layer) when clicking on link an error message "page does not exist yet" appears. In the url "dev" is missing. When I check the file in git bash and run mkdocs serve all links work. After the two links are fixed the issue can be closed.

[tomschenkjr]

@reve0716, I reviewed the dev documentation and the main image appears just fine. Was there another image that wasn't appropriately displaying?

[reve0716]

In the home tab the two links (OpenGrid's API and Service Layer) under the subtitle Technical Architecture are broken. When I select either link it returns an error page.

[tomschenkjr]

Please send the links of where you are referring to.

From: Regina [mailto:notifications@github.com] Sent: Tuesday, March 13, 2018 9:50 AM To: Chicago/opengrid opengrid@noreply.github.com Cc: Tom Schenk Tom.Schenk@cityofchicago.org; Mention mention@noreply.github.com Subject: Re: [Chicago/opengrid] Porting OpenGrid documentation to new docs template (#326)

In the home tab the two links (OpenGrid's API and Service Layer) under the subtitle Technical Architecture are broken.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://github.com/Chicago/opengrid/issues/326#issuecomment-372692175, or mute the threadhttps://github.com/notifications/unsubscribe-auth/ABkC0T4hV9atPCAKDGrp6_9MSWIcEO1-ks5td9yggaJpZM4R5uSU.

---

This e-mail, and any attachments thereto, is intended only for use by the addressee(s) named herein and may contain legally privileged and/or confidential information. If you are not the intended recipient of this e-mail (or the person responsible for delivering this document to the intended recipient), you are hereby notified that any dissemination, distribution, printing or copying of this e-mail, and any attachment thereto, is strictly prohibited. If you have received this e-mail in error, please respond to the individual sending the message, and permanently delete the original and any copy of any e-mail and printout thereof.

[reve0716]

In http://docs.opengrid.io/en/dev/ there are two anchor links called OpenGrid's API and Service Layer that supposed to link directly to the API and Installation and Setup documentation located under the System Administration Tab. When I click on either link it navigates to the following urls: For OpenGrid's API it directs to: http://docs.opengrid.io/en/system-administration/opengrid-api#rest-service-resources For Service Layer it directs to: http://docs.opengrid.io/en/system-administration/installation-and-setup#service-layer

To function… the url should contain /dev/ and should appear as below: OpenGrid's API: http://docs.opengrid.io/en/dev/system-administration/opengrid-api/#rest-service-resources Service Layer: http://docs.opengrid.io/en/dev/system-administration/installation-and-setup/#service-layer

[tomschenkjr]

I still can't reproduce the error. On Monday, please demo the issue.

/cc @joollerer1 for the agenda.

[tomschenkjr]

@reve0716 - I made some corrections and the links appear to work. You just needed to remove the ../ in the links because you were pointing to links underneath the top-level-directory (i.e., you weren't backing-up and moving to a different directory).

Let me know if I had missed any of the broken links before we move this to master.

[reve0716]

The images are broken in layout folder file name called launch-screen.md. The images appears in OG just not converting over to read the docs.

[joollerer1]

Regina to send Tom email on what is not working.

[reve0716]

The documentation was merge and deportation hasn't occurred as we now have new updates to implement for new releases.