Skip to content

Updated script to generate feature catalog files #1735

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

k-a-il
Copy link
Contributor

@k-a-il k-a-il commented Apr 16, 2025

Motivation

Updated script according to changes in JSON schmea file for features files from this PR

  • Removed defaults from script
  • Changed field name from documentation_page to aws_documentation_url

@k-a-il k-a-il requested a review from silv-io April 16, 2025 16:31
@k-a-il k-a-il self-assigned this Apr 16, 2025
Copy link

github-actions bot commented Apr 16, 2025

🎊 PR Preview has been successfully built and deployed to https://localstack-docs-preview-pr-1735.surge.sh 🎊

Copy link
Member

@silv-io silv-io left a comment

Choose a reason for hiding this comment

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

LGTM! I think it is good for those two things to be more explicitly defined

feature_name = f'[{feature_name}]({documentation_page})'
status = feature.get('status', DEFAULT_STATUS)
aws_docs_url = feature.get('aws_documentation_url')
if aws_docs_url:
Copy link
Member

Choose a reason for hiding this comment

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

comment: Since you've made it required in the schema you theoretically won't need this check in there anymore. But I guess it's good to stay defensive :D

@k-a-il k-a-il marked this pull request as ready for review April 17, 2025 09:42
@quetzalliwrites
Copy link
Collaborator

Hey @k-a-il!

I just realized that engineers can merge docs PRs themselves and that we don't have the permission settings setup to require DevRel/Docs maintainers review/sign off. 😸

Just a heads up, that's not the right process. 🙂

Moving forward, I'll need to update the codeowners file likely... but please make sure:

  1. to add at least myself and Harsh to any new docs PRs going forward
  2. no merging until docs maintainer sign off approval ;)

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