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

Docs: mark the utility as public in the package.json file #1102

Closed
ijemmy opened this issue Sep 29, 2022 · 3 comments · Fixed by #1595
Closed

Docs: mark the utility as public in the package.json file #1102

ijemmy opened this issue Sep 29, 2022 · 3 comments · Fixed by #1595
Assignees
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation idempotency This item relates to the Idempotency Utility

Comments

@ijemmy
Copy link
Contributor

ijemmy commented Sep 29, 2022

Description of the improvement

Summary of the proposal
As a part of the implementation of the utility it's necessary to have a dedicated readme file for the utility as well as update the main one in the root of the project.

The first one will be also used in the npm page, the latter will need to be updated to mention the new utility.

How, where did you look for information
Readme of both root and package.

Missing or unclear documentation
Info about the utility.

Improvement
N/A

Related existing documentation

N/A

Related issues, RFCs

#447

@ijemmy ijemmy added documentation Improvements or additions to documentation on-hold This item is on-hold and will be revisited in the future idempotency This item relates to the Idempotency Utility labels Sep 29, 2022
@saragerion saragerion added this to the Idempotency milestone Sep 29, 2022
@dreamorosi dreamorosi changed the title Documentation (idempotency): update README.md in the root folder and the utility folder Docs: update README.md in the root folder and the utility folder Nov 14, 2022
@dreamorosi dreamorosi changed the title Docs: update README.md in the root folder and the utility folder Docs: mark the utility as public in the package.json file Jun 12, 2023
@dreamorosi dreamorosi added confirmed The scope is clear, ready for implementation and removed on-hold This item is on-hold and will be revisited in the future labels Jun 12, 2023
@dreamorosi
Copy link
Contributor

In #1485 we already added the new README.md file for the Idempotency utility and we also have linked the new utility in the main readme file, so I'm repurposing this issue to mark the last tasks to be done before publishing, which are:

  1. Update the package.json file of the utility

We need to remove the private: "true" field and add this one:

"publishConfig": {
  "access": "public"
},
  1. Make visible the documentation page

We need to add the utility to the mkdocs.yml file so that the page shows in the navbar of the docs

@github-actions
Copy link
Contributor

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@github-actions github-actions bot added pending-release This item has been merged and will be released soon and removed confirmed The scope is clear, ready for implementation labels Jul 11, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jul 11, 2023

This is now released under v1.11.1 version!

@github-actions github-actions bot added completed This item is complete and has been merged/shipped and removed pending-release This item has been merged and will be released soon labels Jul 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation idempotency This item relates to the Idempotency Utility
Projects
Development

Successfully merging a pull request may close this issue.

3 participants