General updates to the website

abachma2 commented 6 months ago

This issue is meant as a list to keep track of various changes on the website, such as updates, typos, redesigns, etc. We will do our best to make sure things get updated in a timely manner. Please be sure to name the exact file that should be changed, and ideally the line(s) of the file to be changed.

To add a new item, please edit this comment, using a checkbox for each item

Moving all subtasks into the description so that they are tracked in a single place (@gonuke )

From our initial discussion (@nsryan2 ):

[x] Remove mentions of VM support (people can build their own VM and then install cyclus inside it)
[x] Remove mentions of cyclus-build-deps conda install mentions (there’s a flag you can use to install only dependencies from a conda package).
[x] Update installation minimum packaging

Warnings/issues to handle (@abachma2 ):

[ ] importing cyclus.lazyasd in source/python/lazy_asd.py, module not found
[x] sourcec/cep/cep27.rst lines 32, 34,107, 113, 114, 123, 129, 137, 141, 151, 155, 156, 165, 171, 179, 183
[x] source/cep/cep3.rst line 2
[x] source/cite/index.rst line 47
[x] source/newsletters/oct2017.rst line 111
[x] source/previous/index.rst line 111
[x] source/user/server.rst line 73
[x] source/user/tutorial/add_deploy.rst line 37
[x] source/user/tutorial/add_fab.rst line 4
[x] source/user/tutorial/add_reg_inst.rst line 42, 58
[x] source/user/tutorial/data_explorer.rst lines 121, 124, 192, 231, missing figures
[x] source/user/tutorial/mod_rxtr.rst lines 35, 45
[x] source/user/tutorial/run_cyclus_native.rst line 2
[x] source/user/writing_input.rst line 65
[x] source/arche/cmake.rst line 104

@abachma2 :

[ ] Update the website with new version information.
[x] Reflect change of default branch to main

@nuclearkatie

[x] #365
[x] Contributors list has not been updated any time recently
[x] Last news update was Spring 2018
[x] mbmore links point to Meghan's personal repo, when they are now managed and updated using this cnerg repo
[x] Projects Using Cyclus currently only lists CVT (which doesn't exist anymore)
[x] Copyright on the bottom of the website lists 2012-2016 and the license file lists 2010-2016
[x] Cyclus Funding and Support is probably out of date
- it should probably at least list the NNSA through NA-22 (CTV, MTV) and NA-241 (NNIS fellowship)
[x] If you click Next from the website home page, it takes you to a page called FY2016 NEUP Funding Opportunity with Cyclus. Not sure what else the next button should take you to, but this doesn't seem like the best choice now given how out of date it is
[x] The website still lists a time and zoom link for Cyclus development calls

@abachma2 :

[x] Do we want to keep a list of everyone that has contributed to the project? It's already outdated and while nice, maybe not as necessary now that the team is much larger
[x] Fix link to Numpy contributing documentation to https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard in source/numpydoc/numpydoc.py line 15
[x] Fix broken https://github3py.readthedocs.io/en/master/ link in source/cep/cep6.rst line 87 to https://github3.readthedocs.io/en/latest/

@dean-krueger 👍

[x] Method to install setup.py in Python Archetype Development Tutorial is outdated. Switch to using pip
[ ] Cyclus Inputs Tutorial instructs users to use "-" in names, Cyclus returns an error if this is done. Replace with "_"?
[ ] https://cyrun.fuelcycle.org is down
[x] Missing ">" in example input file for Adding a Separations Facility (Home >> CYCLUS User Guide >> CYCLUS User Tutorial >> Adding a Separations Facility) near the bottom of the file.
[ ] C++ Tutorial "Hello World" has incorrect install instructions: the cycstub github page has different instructions and says that the method described on the tutorial page is "Depreciated"

dean-krueger commented 6 months ago

We could add all the little things I listed in this (https://github.com/orgs/cyclus/projects/3) project since we're messing with the website anyway.

nuclearkatie commented 6 months ago

Should Visualization and Analysis also include third-party tools? I'm specifically thinking about Bicyclus and Trailmap

abachma2 commented 6 months ago

Should Visualization and Analysis also include third-party tools? I'm specifically thinking about Bicyclus and Trailmap

That's a good question. I'm leaning towards no to prevent having to update that list when new things are created. Maybe mention that third-party tools do exist?

abachma2 commented 6 months ago

Do we want to keep a list of everyone that has contributed to the project? It's already outdated and while nice, maybe not as necessary now that the team is much larger

Maybe not? Maybe the best thing to do is just link to Cyclus contributors, and maybe Cycamore and Cymetric contributors

nuclearkatie commented 6 months ago

Do we want to keep a list of everyone that has contributed to the project? It's already outdated and while nice, maybe not as necessary now that the team is much larger

Maybe not? Maybe the best thing to do is just link to Cyclus contributors, and maybe Cycamore and Cymetric contributors

abachma2 commented 6 months ago

Do we want to keep a list of everyone that has contributed to the project? It's already outdated and while nice, maybe not as necessary now that the team is much larger

Maybe not? Maybe the best thing to do is just link to Cyclus contributors, and maybe Cycamore and Cymetric contributors

That's really cool. let's do that. I'll change my comment to include this.

nsryan2 commented 6 months ago

* [ ]  Copyright on the bottom of the website lists [2012-2016](https://github.com/cyclus/cyclus.github.com/blob/0df1c70267381fbf831ffbee92294e59df450599/source/conf.py#L72) and the [license file](https://github.com/cyclus/cyclus.github.com/blob/0df1c70267381fbf831ffbee92294e59df450599/LICENSE.rst#L6) lists 2010-2016

Would this be handled by #316 ? or would an extension to it be needed.

abachma2 commented 6 months ago

* [ ]  Copyright on the bottom of the website lists [2012-2016](https://github.com/cyclus/cyclus.github.com/blob/0df1c70267381fbf831ffbee92294e59df450599/source/conf.py#L72) and the [license file](https://github.com/cyclus/cyclus.github.com/blob/0df1c70267381fbf831ffbee92294e59df450599/LICENSE.rst#L6) lists 2010-2016

Would this be handled by #316 ? or would an extension to it be needed.

I would say it does. I approved and merged that PR, so we'll double check that next time we build

abachma2 commented 6 months ago

* [ ]  Copyright on the bottom of the website lists [2012-2016](https://github.com/cyclus/cyclus.github.com/blob/0df1c70267381fbf831ffbee92294e59df450599/source/conf.py#L72) and the [license file](https://github.com/cyclus/cyclus.github.com/blob/0df1c70267381fbf831ffbee92294e59df450599/LICENSE.rst#L6) lists 2010-2016
Would this be handled by #316 ? or would an extension to it be needed.
I would say it does. I approved and merged that PR, so we'll double check that next time we build

The latest build says 2024 for the copyright, so I would say #316 took care of this one.

dean-krueger commented 6 months ago

Wasn't sure if I should add these to my own comment or to @abachma2 's. Here are the documentation issues I found while I was learning how to use Cyclus from the website.

abachma2 commented 6 months ago

I removed some of the items about files not being in a toc tree. This is only shown when you build the website, and it doesn't prevent the site from being built and there are some good reasons to not have some of these items in toc trees.

gonuke commented 2 months ago

Should we close this out by creating separate issues for the lingering items?

cyclus / cyclus.github.com

General updates to the website #337