manual reorg items -- from 2021-07-08 VisIt meeting

visit-dav / visit

VisIt - Visualization and Data Analysis for Mesh-based Scientific Data

https://visit.llnl.gov

BSD 3-Clause "New" or "Revised" License

408 stars 109 forks source link

manual reorg items -- from 2021-07-08 VisIt meeting #5885

Open cyrush opened 3 years ago

cyrush commented 3 years ago

[x] Move Intro to VisIt from GUI Manual to Top level
[x] Move installing visit from GUI Manual to Getting Started
[x] Rename GUI Manual to Using VisIt
[x] Start Using VisIt with Main Window
[x] First section should be Getting Started (not necessary building visit)
[x] rename and move How to search
[x] Remove duplicate intro in CLI manual
[x] Rename CLI Manual to Python Scripting
[ ] CLI vs GUI origination: Can we Add Tags for Categories for CLI entries to help group them
[ ] Introduce recording scripts earlier in the manual (since many people learn python via GUI recording)
[x] Move Acknowledgements from GUI Manual to top level at the end
[x] Move Glossary from GUI manual to Top level at the end
[ ] Add more stuff to the Glossary
[x] Move and rename Contributing Docs in GUI and CLI Manuasl (which are about Contributing Docs not about Contributing in General) to the Developer Docs

brugger1 commented 2 years ago

We should turn the bullets into check boxes and then check them off as we do them.

brugger1 commented 2 years ago

I parsed through the items to be done and here is what I believe to be the top level chapters.

Getting Started
Intro to VisIt
Using VisIt
Python Scripting
Tutorials
Developer Documentation
How to Search this Manual
Acknowledgements
Glossary

Should "Building VisIt" be part of "Developer Documentation" or a chapter just before "Developer Documentation"?

Comments?

markcmiller86 commented 2 years ago

Should "Building VisIt" be part of "Developer Documentation" or a chapter just before "Developer Documentation"?

My recollection is that we felt building visit should be wrapped up into its own top-level chapter or part of "installing" in Getiting Started. We probably should not bury it down, somewhere in developer docs.

brugger1 commented 2 years ago

I agree that burying it in developer docs is not the best idea, but I just couldn't recall where we decided to move it. I think it would be fine as a top level directory or in getting started, since I would expect anyone new to VisIt would presumably go there. I think I would have the slightest preference to be a top level chapter just before developer documentation. Any other opinions?

markcmiller86 commented 2 years ago

I think I would have the slightest preference to be a top level chapter just before developer documentation

:+1:

Well, there's no reason we can't compose it once and then link to it from toc's where appropriate. So, I like having it both as a sub-section under a top-level Getting Started and as a top-level Building VisIt from Sources coming just before Developer Documentation in the top-level list. Does that make sense?

biagas commented 2 years ago

👍

brugger1 commented 2 years ago

Sounds like a winner! I'll make it so (channeling Jean-Luc Picard).