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

Duplicate install instructions #361

Closed
abachma2 opened this issue Apr 11, 2024 · 3 comments
Closed

Duplicate install instructions #361

abachma2 opened this issue Apr 11, 2024 · 3 comments
Assignees

Comments

@abachma2
Copy link
Member

Looking at source/user/install.rst, there are multiple links for each type of install. There is a list of the install types, with some recommendations, and there is a toctree with the file names. So this creates a duplicate of the list. Some paths on how to remedy this:

  • Leave the :doc: elements with the recommendations in install.rst, and remove the doc tree
  • Remove the :doc: elements, leaving the toctree in install.rst. This would likely involve moving the recommendations into each of the files to keep that information present for users.
@abachma2 abachma2 self-assigned this Apr 11, 2024
@bennibbelink
Copy link
Contributor

I personally think that it is helpful to have the recommendations, so I'm partial to the first bullet above. It would also require that we add a :doc: element for the Docker Install option.

Could we possibly remove the references to "Custom" and "CMake" Cyclus Installations from install.rst since they are only relevant to installing from source? Both the "via Tarball" and "via Repository" pages reference the custom build options already.

@abachma2
Copy link
Member Author

That's another thing I modify for this.

@abachma2
Copy link
Member Author

I believe this was addressed in #362, so I'm closing it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants