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

[docs]: Perhaps remove page E4S #138

Open
shahzebsiddiqui opened this issue May 24, 2024 · 4 comments
Open

[docs]: Perhaps remove page E4S #138

shahzebsiddiqui opened this issue May 24, 2024 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@shahzebsiddiqui
Copy link
Collaborator

Please describe the issue

@sameershende @eugeneswalker

I had documented this page https://e4s.readthedocs.io/en/latest/spack.html but it looks like this is already out of date and considering we have lots of spack configuration. I think if we are not going to document every release in this page i would vote for removing this page. This page showed the spack configuration in readthedocs in rendered form so it was somewhat convenient if one is reading the docs and sees the spack configuration

Screenshot 2024-05-24 at 10 57 13 AM
@shahzebsiddiqui shahzebsiddiqui added the documentation Improvements or additions to documentation label May 24, 2024
@wspear
Copy link
Contributor

wspear commented May 24, 2024

I don't think keeping this up to date will be terribly onerous. It hasn't been on my radar though. I'd like some more feedback on if we should maintain or remove it before I proceed.

@nchaimov
Copy link
Collaborator

To help ensure that we keep documentation like this up to date, it might be a good idea to create a release procedure checklist that lists what pages need to be updated when new releases of E4S come out. That way we don't forget about something.

@shahzebsiddiqui
Copy link
Collaborator Author

That's a good idea @nchaimov

@shahzebsiddiqui
Copy link
Collaborator Author

This should be updated https://e4s.readthedocs.io/en/latest/introduction.html#references

I wrote this up a while back so we can put references in the docs.

Anyway I recommend that you all should read and get familiar with the docs and what's written so it can be improved.

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

No branches or pull requests

5 participants