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

Doc: Adding Openapi Links #382

Merged
merged 8 commits into from
Mar 1, 2024
Merged

Conversation

DhairyaMajmudar
Copy link
Member

@DhairyaMajmudar DhairyaMajmudar commented Feb 28, 2024

GitHub Issue: #127
closes #127

Summary:

Added OpenAPI links to the website, changed the openAPI text to openAPI links which redirects to the open API website. The links are added to 6 relevant places.

Files Changed

  1. pages/implementations/main.md

Screenshot Before
image

Screenshot After
image

Do you think resolving this issue might require an Architectural Decision Record (ADR)? (significant or noteworthy)

No
[JUSTIFICATION]

Copy link

Hey there 👋!

Are you an implementer of a new JSON Schema related tool, or an interested user submitting a tool you like?
If so, thanks for considering adding your tool to our collection -- and if not, sorry, I'm just a bot looking at which pages you're modifying!

Someone will review your pull request shortly.

In the interim, if you haven't already, there's a few things you might be interested in reviewing or confirming:

  1. Short description: Tell us a small bit about your tool! We love staying up to date on what's out there, and what your intentions are in writing it.
  2. Come Join Our Slack!: We have an #implementers channel for anyone interested in or building JSON Schema tooling!
    An invite can be found here or on our homepage!
  3. Common Interfaces: We maintain a page with some "commonly useful programming interfaces" that tooling may want to implement and present to your users.
    You can find that page here in our documentation.
    Have a read through and consider whether you implement or should implement any of what's there.
  4. Bowtie Harness: Bowtie is a tool which gives JSON Schema users access to a huge number of different implementations across many languages, and reports on the compliance of those implementations with the JSON Schema specifications.
    If it makes sense for your kind of tool, consider writing a harness which connects it to Bowtie. Instructions for doing so can be found in the tutorial in Bowtie's documentation.

If you have any questions, any feedback, or need help with the submission process, don't hesitate to reach out.
Thanks a bunch for your awesome contribution!

@DhairyaMajmudar
Copy link
Member Author

@benjagm @karenetheridge pls. have a look, I have added the links to about 6 places where it felt relevant to me. If you needed links to be added in more places I will be happy to do so : )

Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

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

Left some suggestions. I think we should add the link to the OpenAPI subcategory in the Format converters section too.

Good job here!

pages/implementations/main.md Outdated Show resolved Hide resolved
pages/implementations/main.md Outdated Show resolved Hide resolved
pages/implementations/main.md Outdated Show resolved Hide resolved
@DhairyaMajmudar
Copy link
Member Author

Thank you @benjagm, I have made the suggested changes.

@benjagm benjagm added the Status: Review Needed The issue has a PR attached to it which needs to be reviewed. label Feb 29, 2024
@karenetheridge
Copy link
Member

Before merging, could this be rebased+squashed please?

@DhairyaMajmudar
Copy link
Member Author

Before merging, could this be rebased+squashed please?

Yeah sure

@benjagm benjagm merged commit ad294ca into json-schema-org:main Mar 1, 2024
@DhairyaMajmudar DhairyaMajmudar deleted the openapi branch March 1, 2024 12:02
@DhairyaMajmudar DhairyaMajmudar changed the title Adding Openapi Links Doc: Adding Openapi Links Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Review Needed The issue has a PR attached to it which needs to be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add links to openapi website
3 participants