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.

Sign up for GitHub

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

Jump to bottom

build: Add structured Maintainers information #370

Merged
merged 2 commits into from
Apr 26, 2024
Merged

build: Add structured Maintainers information #370

merged 2 commits into from
Apr 26, 2024

Conversation

felipemontoya
Copy link
Member

This PR adds the catalog-info.yaml file for backstage.
I'm including myself as the owner due to me being the only current maintainer.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 26, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @felipemontoya! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@felipemontoya felipemontoya requested a review from feanil April 26, 2024 17:28
@felipemontoya
Copy link
Member Author

@feanil care to check if the catalog file is correct for a new maintainer?

feanil
feanil approved these changes Apr 26, 2024
View reviewed changes
Copy link
Contributor

@feanil feanil left a comment

Choose a reason for hiding this comment

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

One suggestion but otherwise looks good. Feel free to merge at your leisure.

catalog-info.yaml Outdated
name: 'edx-organizations'
description: "Django application responsible for managing the concept of Organizations in the Open edX platform"
links:
- url: "https://github.com/openedx/edx-organizations"
Copy link
Contributor

Choose a reason for hiding this comment

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

You don't need this link, Backstage will always link back to the source code automatically.

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe link to the relevant RTD if there is one instead?

@felipemontoya felipemontoya merged commit dee1f11 into master Apr 26, 2024
10 checks passed
@felipemontoya felipemontoya deleted the fmo/catalog branch April 26, 2024 19:58
@openedx-webhooks
Copy link

@felipemontoya 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@feanil feanil feanil approved these changes

Assignees
No one assigned
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@felipemontoya @openedx-webhooks @feanil