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

Restructure "Federating Your Data" docs to discuss philosophy of namespaces #1776

Open
jhiemstrawisc opened this issue Nov 26, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation Facilitation A request from the RCF's

Comments

@jhiemstrawisc
Copy link
Member

@aowen-uwmad has requested more structured docs pertaining to how to pick a federation namespace for new origins. I'd like to use this as an excuse to do some restructuring for our "Federating Your Data" documentation section.

Right now our ToC has something like:

Federating Your Data: --> page describing step by step how to set up an origin, assuming Posix.
    S3 Backend --> page describing S3 backend specific information
    Generating Tokens --> How to generate various tokens

I'd like this to instead be something like:

Federating Your Data: --> page describing philosophy (origins, their roles in a federation, how to choose a namespace, etc)
    Setting Up An Origin --> Page with step-by-step instructions for generic origin configuration
    Posix-Specific Backend Considerations --> Talk about user mapping, etc. Justin needs help with this.
    S3-Specific Backend Considerations --> page describing S3 backend specific information
    HTTPs-Specific  Backend Considerations --> First pass at documenting this. Maybe even some docs about globus?
    Origins and Token Management
@jhiemstrawisc jhiemstrawisc added documentation Improvements or additions to documentation Facilitation A request from the RCF's labels Nov 26, 2024
@jhiemstrawisc jhiemstrawisc self-assigned this Nov 26, 2024
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 Facilitation A request from the RCF's
Projects
None yet
Development

No branches or pull requests

1 participant