Skip to content

Commit

Permalink
WD: Museum API project
Browse files Browse the repository at this point in the history
Merge pull request #2119 from writethedocs/wd-museumAPI-proj
  • Loading branch information
rosewms committed Mar 29, 2024
2 parents c938796 + 8707e09 commit d15b885
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions docs/conf/portland/2024/writing-day.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Project List
Docs as Tests & Doc Detective: Help us test your docs!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**Meet the team, get set up with tools or strategies, run some tests.**
Project organizer Manny Silva, he/him.

`Doc Detective <https://doc-detective.com/>`__ is back at Writing Day again, this time with our friends, `Docs as Tests <https://www.docsastests.com>`__. Does your project or product have a UI? APIs? SDKs? We can help you test them and keep your docs accurate.

Expand All @@ -126,14 +126,16 @@ Come by our table, and we'll help you set up Docs as Tests with whatever tools (
Mutual Aid for Tech Writer/Documentarian Job Hunters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Coordinated by Kenzie Woodbridge, they/them. Let's help each other get ready for our job searches!
Coordinated by Kenzie Woodbridge, they/them.

Are you thinking of applying for a new or different tech writer/documentarian job and would appreciate feedback on your resume? Or, are you responsible for hiring and know what you're looking for in a resume and application? Let's get together and offer each other some feedback on the important documentation we're using to move our careers forward.
Let's help each other get ready for our job searches! Are you thinking of applying for a new or different tech writer/documentarian jobs and would appreciate feedback on your resume? Or, are you responsible for hiring and know what you're looking for in a resume and application?

Let's get together and offer each other some feedback on the important documentation we're using to move our careers forward.

Meet the new GitBook
^^^^^^^^^^^^^^^^^^^^

**Meet the team, explore the new GitBook, publish your first site**
Project organizer Addison Schultz, he/him.

Our mission at `GitBook <https://gitbook.com/>`__ is to help you harness your team's knowledge!

Expand All @@ -151,6 +153,17 @@ It gets better! For every challenge completed, you'll receive one (1) entry for

Already familiar with GitBook? We're looking for people like you to brainstorm features as. Help us make the ultimate documentation platform!

Use OpenAPI with the Museum API
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Project organizer Heather Cloward, she/her.

The `Museum API <https://github.com/Redocly/museum-openapi-example/tree/main>`__ is a sample OpenAPI description. It offers a set of endpoints to interact with a museum's services -- such as retrieving museum hours, managing special events, and purchasing tickets.

Our Writing Day goal is to onboard contributors and improve the Museum API definition. Help us create more complex use case examples like discriminator, webhooks, oneOf, allOf, etc.

The Museum API was built specifically to teach OpenAPI concepts and to create a better developer experience. The more realistic and complex the Museum API is, the better it can demonstrate all that OpenAPI has to offer.

*More projects coming, get excited!*

Contact Us
Expand Down

0 comments on commit d15b885

Please sign in to comment.