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

Add folders to examples to help organize examples #262

Open
kevinduffey opened this issue Oct 15, 2024 · 2 comments
Open

Add folders to examples to help organize examples #262

kevinduffey opened this issue Oct 15, 2024 · 2 comments
Labels
house-keeping House keeping items

Comments

@kevinduffey
Copy link
Collaborator

Was just looking at examples and I believe having examples in separate folders to organize the examples and/or use cases will make it easier to find more specific examples than scrolling through the growing list of examples we will hopefully have.

A folder like Authentication-Examples (or just Authentication) might work to separate oauth/token/etc examples.
One for Travel (and then folders below that if need be to organize travel examples).

Thoughts?

@frankkilcommins
Copy link
Collaborator

It might also be worth considering migrating examples over to https://github.com/OAI/learn.openapis.org/tree/main. That might also need a rethink as to how that is structured and it also reminds me of a long outstanding task to create some material for that repo on Arazzo specifically.

FYI - recent and new examples for OAS are exclusively on https://github.com/OAI/learn.openapis.org/tree/main rather than within the specification repo (good or bad - that's the current status).

@frankkilcommins frankkilcommins added the house-keeping House keeping items label Oct 23, 2024
@handrews
Copy link
Member

@frankkilcommins yeah, we found it was problematic to direct people to the GitHub repo for things because it limited our ability to manage our repo directory and branch structure to best suit our needs. Moving the examples to the learn site (they will be deleted from the spec repo soon) was one of the things we decided to do to get back to the GitHub structure being an internal detail of the project and not a public interface. The spec, learn, and tools sites are the public interfaces.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
house-keeping House keeping items
Projects
None yet
Development

No branches or pull requests

3 participants