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

Removing the RFC documentation #532

Open
ecbland opened this issue Oct 24, 2022 · 5 comments
Open

Removing the RFC documentation #532

ecbland opened this issue Oct 24, 2022 · 5 comments
Milestone

Comments

@ecbland
Copy link

ecbland commented Oct 24, 2022

DEPRECATION

We had planned to remove the RFC documentation from the RST after migrating the content to readthedocs in #377.

<div id="main">
<center>
<h3>Superdarn Request for Comments documents</h3>
</center>
<br>
<center>
<h3>DEPRECATION NOTICE: The RFC documentation is being deprecated with RST version 4.6 and will be removed with RST 4.7. This documentation has been moved to the <a href="https://radar-software-toolkit-rst.readthedocs.io/en/latest/">documentation website</a>. </h3>
<h5>CAUTION: These Request for Comments documents have not been updated or maintained since the mid-2000s and may contain inaccurate or outdated information</h5>
</center>

It would be nice to do this for the RST5.0 release, but please chime in if there's a good reason to keep it a bit longer. I had a quick look at the code and it seems fairly simple to remove. (see also #47 when the RFC documentation was added)

While looking at the code I also noticed a script for building tutorial documentation, make.doc.tutorial, but I'm not sure where the source code is. Do these tutorials exist?

@egthomas
Copy link
Member

@ecbland a snapshot of the old tutorials can be found here:

https://web.archive.org/web/20050908143338/http://superdarn.jhuapl.edu/devel/tutorial/index.html

I used that information to populate the tutorials on the wiki page several years ago (e.g., https://github.com/SuperDARN/rst/wiki/Working-With-Data).

I would not be in favor of removing the RFC documentation from the RST, but admit I am probably in the minority on that front.

@pasha-ponomarenko
Copy link
Contributor

pasha-ponomarenko commented Oct 24, 2022

@ecbland, I don't have any strong opinion on this, but if this information is either redundant or outdated, then it makes sense to remove it from RST and to archive somewhere on this repository.

@mtwalach
Copy link
Contributor

Personally, I do use the RFC docs occasionally and I do like having them though I appreciate they are perhaps not very accessible and I don't have a good reason either (other than, I occasionally use them but it's probably just Evan and I).

@ksterne
Copy link
Contributor

ksterne commented Oct 26, 2022

Interesting to hear that there's still usage of these since I'm not sure how up-to-date they are! Is it helpful or possible to use our readthedocs site (https://radar-software-toolkit-rst.readthedocs.io/en/latest/)? I think I'm mostly asking @egthomas and @mtwalach so far. When we discussed this a bit ago, we figured moving all of the documentation to a central location would be beneficial.

@ecbland
Copy link
Author

ecbland commented Oct 28, 2022

Thanks for the input on this discussion. I don't want this to hold up making the release branch, since we have 1 month of testing ahead of us. If we land on a decision during that testing then we can make the changes on the release branch. I'll leave this issue open so that it stays on our WG's agenda.

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

No branches or pull requests

5 participants