E4S-Project / e4s

E4S for Spack
https://e4s.readthedocs.io
MIT License
30 stars 13 forks source link

[docs]: Perhaps remove page E4S #138

Open shahzebsiddiqui opened 5 months ago

shahzebsiddiqui commented 5 months ago

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
wspear commented 5 months ago

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 commented 5 months ago

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 commented 5 months ago

That's a good idea @nchaimov

shahzebsiddiqui commented 5 months ago

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.