Skip to content

docs: update README and Swagger as EarthPortal API Federated Service#17

Merged
Cpierkot merged 3 commits into
devfrom
docs/update-readme
May 29, 2026
Merged

docs: update README and Swagger as EarthPortal API Federated Service#17
Cpierkot merged 3 commits into
devfrom
docs/update-readme

Conversation

@Imene-Amirat
Copy link
Copy Markdown
Collaborator

@Imene-Amirat Imene-Amirat commented May 22, 2026

Update the documentation as EarthPortal API Federated Service

Changes :

  • README: new title, fork notice, "within EarthPortal" instead of "within NFDI"
  • Swagger: title and description updated to remove TS4NFDI mentions and promote EarthPortal

Copilot AI review requested due to automatic review settings May 22, 2026 13:15
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the repository README branding to “EarthPortal API Federated Service” and adjusts introductory/installation documentation to reflect the EarthPortal fork.

Changes:

  • Renames the README title and overview text from TS4NFDI API Gateway to EarthPortal API Federated Service.
  • Updates installation instructions to clone/use the EarthPortal repository name.
  • Minor markdown formatting tweaks (e.g., image formatting/spacing).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md
@Imene-Amirat Imene-Amirat changed the title docs: rename README as EarthPortal API Federated Service docs: update README and Swagger as EarthPortal API Federated Service May 22, 2026
@Imene-Amirat Imene-Amirat requested a review from hakimalem May 22, 2026 15:00
@Imene-Amirat Imene-Amirat self-assigned this May 22, 2026
@Imene-Amirat Imene-Amirat added the documentation Improvements or additions to documentation label May 22, 2026
@Cpierkot Cpierkot merged commit 7c6e505 into dev May 29, 2026
@Imene-Amirat
Copy link
Copy Markdown
Collaborator Author

@hakimalem should I rename the URL path from /api-gateway/ to /api-federation/, or keep it as is?

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants