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

Porting OpenGrid documentation to new docs template #326

Open
tomschenkjr opened this issue Feb 5, 2018 · 13 comments
Open

Porting OpenGrid documentation to new docs template #326

tomschenkjr opened this issue Feb 5, 2018 · 13 comments
Assignees

Comments

@tomschenkjr
Copy link
Contributor

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
Copy link
Contributor

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

@tomschenkjr
Copy link
Contributor Author

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
Copy link
Contributor

reve0716 commented Mar 1, 2018

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

@reve0716
Copy link
Contributor

reve0716 commented Mar 7, 2018

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.

2018-03-07_1248

2018-03-07_1255

@tomschenkjr
Copy link
Contributor Author

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

@reve0716
Copy link
Contributor

reve0716 commented Mar 13, 2018

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.

2018-03-13_0942

@tomschenkjr
Copy link
Contributor Author

tomschenkjr commented Mar 13, 2018 via email

@reve0716
Copy link
Contributor

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
Copy link
Contributor Author

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

/cc @joollerer1 for the agenda.

tomschenkjr pushed a commit that referenced this issue Mar 26, 2018
@Regina.Hightower reported some issues with broken links on the front
page. Changed the links from `../path/to/page.html` to
`path/to/page.html`. This worked on local testing with `mkdocs serve`
command. It should also work at `docs.opengrid.io/en/dev/`.
@tomschenkjr
Copy link
Contributor Author

@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
Copy link
Contributor

reve0716 commented Apr 9, 2018

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
Copy link

Regina to send Tom email on what is not working.

tomschenkjr pushed a commit that referenced this issue Jun 19, 2018
* Updated z-index for Issue #250

* Issue 293 - Updated Margin to support a small field name

* Updated _getChartXAxisInfo

Removed unnecessary check on view.creationTimestamp field. Chart class is able to handle nulls correctly.

* Updated Cloud Cover URL

* Updated Cloud Cover URL

Typo in URL

* add new files and images for new doc conversion

* re-formatted the table

* reformatted table

* Updated the relative path for the images

* add new img for find panel

* update img

* update image to match OG Panel

* formatted table and updated relative path to imgs

* added img to match opengrid

* update site folder

* update yml ext

* update site file

* Rename file

* Rename Installation and Setup file with dashes

* Rename Opengrid api

* Rename OpenGrid Configuration

* rename files and update documents

* added new folder

* removed from folder

* update index file

* remove index file from sys admin folder

* update index file

* removed dup file

* update index file with relative path

* update site folder docs

* update index.html

* update the path to linking pages

* updated folder

* update index file

* update index and add file in new folder

* updated relative links in files from sys admin folder

* add order list to files

* minor changes to files

* update index file

* update index file

 Changes to be committed:
	modified:   site/index.html
 Changes not staged for commit:
	modified:   site/index.html

* update index file for dev

* rename the file to lowercase

* change to lowercase

* file name lowercase

* change filename to be lowercase

* Rename Architecture.md to architecture.md

* change filename to lowercase

* change filenames to lowercase

* remove files that are no longer in use

* update logo index file

* updated table

* update image cloudy.png

* update images relative path for weather

* updating relative path

* Update index.md

* Update index.md

* Update index.md

* update images

* update images location

* update index.md links and images

* Update index.md

* update link

* Update index.md

* Update index.md

* Update index.md

* relative path

* Update index.md

* Update index.md

* update path to opengrid logo

* Fixed broken links. See #326

@Regina.Hightower reported some issues with broken links on the front
page. Changed the links from `../path/to/page.html` to
`path/to/page.html`. This worked on local testing with `mkdocs serve`
command. It should also work at `docs.opengrid.io/en/dev/`.
@reve0716
Copy link
Contributor

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

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

3 participants