search

ncsa / TGI_RAILS_Documentation

1 stars 1 forks source link

The python instructions are not organized in the contents list #3

Open robertkb opened 5 months ago

robertkb commented 5 months ago

The Python instructions are not in the right place in the contents list, and there are scattered stubs that have no docs under them. There is a Python entry under Programming Environments that is empty. There is another Python entry in Installed Software that is also empty. The actual python content is only in a link at the bottom of the Installed Software page, after an empty entry for R

craigsteffen commented 5 months ago

Sorry for the delay, @robertkb. I'm looking at this now.

craigsteffen commented 5 months ago

Ok, I think the problem here is that Python has somehow been embedded under R, which I don't think it should be. I suspect that one of the TOC entries has a mistake in the indentation.

craigsteffen commented 5 months ago

@brettbode Robert noticed that the indexing under this page on the Rails documentation: https://ncsa-tgi-rails-documentation.readthedocs-hosted.com/en/latest/software/index.html is less than optimal.

I don't have any direct connection to Rails, but as someone who works on documentation, any objection to me cleaning this up so that the indexing is more logical?

craigsteffen commented 5 months ago

@robertkb I have created a branch that (I think) fixes the immediate acute index problems on the Installed Software page in the TGI Rails documentation. It maybe could be indexed slightly differently, but the content that's there is now tied into the index on the left logically. My changes are in a branch that's being built called "clean_software_index": https://ncsa-tgi-rails-documentation.readthedocs-hosted.com/en/clean_software_index/software/index.html (you'll have to be logged into readthedocs.com to see it)

However, as far as the stub pages, my guess is that's because no one has written them yet. Looking at the repository, it appears to have pretty much been written by Brett and Jeremy, and I see you and Celso and Jim have made edits. I talked to Lillian, and she's not on deck for generating or editing content for that system's documentation. I would assume that means that Brett never talked to Sandie and Lillian to get them on board for being part of that documentation.

So as far as getting the rest of the documentation populated, I think either talk to Brett and Jeremy, or else ask them to get that documentation put under Lillian's umbrella so that it gets updated with everything else.

I will submit the branch that I've created for review if Brett wants to include it. But I don't get funded for work on Rails as far as I know, so I don't feel I can spearhead a big effort unless I'm told to, or unless that changes.