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

doc: update index.rst to include references to scion-application-docs #4623

Merged
merged 3 commits into from
Sep 23, 2024

Conversation

JordiSubira
Copy link
Contributor

@JordiSubira JordiSubira commented Sep 17, 2024

After an offline discussion from SCION contributors, we reached the conclusion that docs.scion.org is the best-suited candidate to host technical information about SCION applications (ideally already in a certain maturity level) since they can be run on different environments, i.e., production network, SCIONLab or local dev environment. It may also help to centralize a little bit the information and making the documentation environment a bit less hairy for the users/developers.

In this PR, I ported the Applications section in the SCIERA docs , adding the file doc/applications/access.rst as a preliminary documentation as how to connect the application host to the diverse SCION networks.

We can revisit, if some of documentation for the currently listed applications must be removed or updated.


We use RTD subprojects and the project is located in https://github.com/scionproto-contrib/scion-applications-docs.

This PR adds reference to the SCION Applications subproject.

@jiceatscion
Copy link
Contributor

This change is Reviewable

@jiceatscion jiceatscion removed their assignment Sep 17, 2024
@jiceatscion jiceatscion requested a review from a team September 17, 2024 16:46
@jiceatscion
Copy link
Contributor

Hmm, I'm not sure if we should do that. These applications are not part of the scionproto repo. This means that their maintainers and the scionrpto repo maintainers aren't necessarily the same people. Would the scion TC implementation want to become a necessary agent for every change made to these applications, which requires updating their documentation?

I understand the desire to make everything about scion easy to find, but I am not so sure this is the way to go.

Other opinions?

@jiceatscion jiceatscion self-assigned this Sep 17, 2024
Copy link
Contributor

@oncilla oncilla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you considered using RTD subprojects: https://docs.readthedocs.io/en/stable/subprojects.html for this?

Reviewable status: 0 of 7 files reviewed, all discussions resolved (waiting on @jiceatscion)

@JordiSubira
Copy link
Contributor Author

JordiSubira commented Sep 17, 2024

@jiceatscion it is a fair point, I also thought about that and at the beginning I also thought about a dedicated readthedocs for SCION applications. However, I also believe it is a valid concern having to many places for the information, especially right now. At this moment, the people administrating this will be the same people as attend the SCION contributors meetings. In the future, hopefully many new developers comes into the picture, but in the near/mid-term I do not see much of a problem with us curating this, because it will be mostly us or people supervised by us, the ones who will contribute to this.

@oncilla I will take a look into this, definitely, it seems like a good solution that would suite both cases, i.e. having everything centralized while dividing maintenance/curation efforts. Thank you :)

@JordiSubira
Copy link
Contributor Author

Following @oncilla suggestion, we moved the contents to a subproject https://docs.scion.org/projects/scion-applications/en/latest
I will update the descritpiton accordingly

@JordiSubira JordiSubira changed the title [doc]: update application documentation [doc]: update index.rst to include references to scion-application-docs Sep 18, 2024
@JordiSubira JordiSubira changed the title [doc]: update index.rst to include references to scion-application-docs doc: update index.rst to include references to scion-application-docs Sep 18, 2024
Copy link
Contributor

@jiceatscion jiceatscion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

Reviewed 1 of 1 files at r3, all commit messages.
Reviewable status: 1 of 7 files reviewed, all discussions resolved

Copy link
Contributor

@jiceatscion jiceatscion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 6 of 7 files at r2.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @JordiSubira)

Copy link
Contributor

@jiceatscion jiceatscion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 1 of 1 files at r4, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @JordiSubira)

@JordiSubira JordiSubira merged commit f0f7162 into scionproto:master Sep 23, 2024
5 checks passed
@JordiSubira JordiSubira deleted the doc_applications branch September 23, 2024 11:02
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

Successfully merging this pull request may close these issues.

3 participants