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

feat(docs): Add id to success message response for docs and docs:single #583

Merged

Conversation

garrett-wade
Copy link
Contributor

🚥 Fix RM-XXX

🧰 Changes

Added the id of a document to the success response when a document is uploaded. We often have developer publishing a single doc that will be used as the parent for another doc, and getting the id directly in the response improves the experience for the developer.

🧬 QA & Testing

Run the docs:single or docs command on a file you wish to upload.
Notice the id is added to the success message(s) printed in the console.

@kanadgupta kanadgupta added enhancement New feature or request command:docs Issues pertaining to the `docs`, `changelogs`, or `custompages` commands labels Aug 29, 2022
Copy link
Member

@kanadgupta kanadgupta left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @garrett-wade—this change makes a lot of sense! One small copy suggestion below, otherwise LGTM!

src/lib/pushDoc.ts Outdated Show resolved Hide resolved
Copy link
Member

@erunion erunion left a comment

Choose a reason for hiding this comment

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

can you take a look at the tests again here @garrett-wade? looks like they're all failing with that message change.

@kanadgupta
Copy link
Member

Thanks @garrett-wade!

@kanadgupta kanadgupta dismissed erunion’s stale review September 6, 2022 14:30

tests are updated

@kanadgupta kanadgupta merged commit a9d7099 into readmeio:main Sep 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
command:docs Issues pertaining to the `docs`, `changelogs`, or `custompages` commands enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants