Skip to content

Conversation

@WilliamLindskog
Copy link
Member

@WilliamLindskog WilliamLindskog commented Dec 2, 2025

docs(supergrid): Add documentation on how to register supernode to supergrid

Issue

Description

There was no comprehensive documentation guide for users who want to register SuperNodes to the Flower SuperGrid using authentication keys. Users needed a step-by-step guide covering the entire process from prerequisites to troubleshooting.

Related issues/PRs

N/A - This is a new documentation contribution.

Proposal

Explanation

Added a new comprehensive how-to guide how-to-register-supernodes-on-supergrid.rst that provides:

  • Complete prerequisites and setup instructions
  • Step-by-step authentication key generation process
  • Project configuration details
  • SuperGrid login and verification procedures
  • Detailed SuperNode registration workflow
  • Docker-based SuperNode initialization instructions
  • Federated task execution guidance
  • Common troubleshooting scenarios and solutions
  • Quick reference commands and checklist

The guide has been integrated into the deployment documentation section in deploy.rst, positioned logically after the existing SuperNode authentication guide.

Checklist

  • Implement proposed change
  • Write tests (N/A for documentation)
  • Update documentation
  • Make CI checks pass
  • Ping maintainers on Slack (channel #contributions)

Any other comments?

This documentation is based on the official SuperGrid registration workflow and provides users with all the information needed to successfully register and manage SuperNodes on the Flower SuperGrid platform.

@WilliamLindskog WilliamLindskog changed the title docs(supergrid): Add documentation on how to register supernode to su… docs(framework): Add documentation on how to register supernode to su… Dec 2, 2025
@github-actions github-actions bot added the Maintainer Used to determine what PRs (mainly) come from Flower maintainers. label Dec 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Maintainer Used to determine what PRs (mainly) come from Flower maintainers.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants