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

General updates to the website #337

Open
32 of 37 tasks
abachma2 opened this issue Mar 21, 2024 · 11 comments
Open
32 of 37 tasks

General updates to the website #337

abachma2 opened this issue Mar 21, 2024 · 11 comments
Assignees
Milestone

Comments

@abachma2
Copy link
Member

abachma2 commented Mar 21, 2024

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 ):

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

Warnings/issues to handle (@abachma2 ):

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

@abachma2 :

  • Update the website with new version information.
  • Reflect change of default branch to main

@nuclearkatie

@abachma2 :

@dean-krueger 👍

  • 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
  • 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"
@abachma2 abachma2 self-assigned this Mar 21, 2024
@dean-krueger
Copy link

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

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

@abachma2
Copy link
Member Author

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

abachma2 commented Mar 21, 2024

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

nuclearkatie commented Mar 21, 2024

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

abachma2 commented Mar 21, 2024

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

nsryan2 commented Mar 21, 2024

* [ ]  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
Copy link
Member Author

* [ ]  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

@gonuke gonuke added this to the v1.6 milestone Mar 29, 2024
@abachma2
Copy link
Member Author

abachma2 commented Apr 1, 2024

* [ ]  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.

@cyclus cyclus deleted a comment from nsryan2 Apr 3, 2024
@cyclus cyclus deleted a comment from abachma2 Apr 3, 2024
@cyclus cyclus deleted a comment from abachma2 Apr 3, 2024
@cyclus cyclus deleted a comment from nuclearkatie Apr 3, 2024
@cyclus cyclus deleted a comment from nuclearkatie Apr 3, 2024
@cyclus cyclus deleted a comment from abachma2 Apr 3, 2024
abachma2 added a commit to abachma2/cyclus.github.com that referenced this issue Apr 3, 2024
abachma2 added a commit to abachma2/cyclus.github.com that referenced this issue Apr 3, 2024
abachma2 added a commit to abachma2/cyclus.github.com that referenced this issue Apr 3, 2024
@dean-krueger
Copy link

dean-krueger commented Apr 11, 2024

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

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.

bennibbelink pushed a commit to abachma2/cyclus.github.com that referenced this issue Apr 18, 2024
bennibbelink pushed a commit to abachma2/cyclus.github.com that referenced this issue Apr 18, 2024
bennibbelink pushed a commit to abachma2/cyclus.github.com that referenced this issue Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Progress
Development

No branches or pull requests

5 participants