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.

Sign up for GitHub

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

Jump to bottom

[Logger] Missing readme headers #14726

Closed
KarishmaGhiya opened this issue Apr 5, 2021 · 1 comment · Fixed by #15734
Closed

[Logger] Missing readme headers #14726

KarishmaGhiya opened this issue Apr 5, 2021 · 1 comment · Fixed by #15734
Assignees
@chradek
Labels
Azure.Core Client This issue points to a problem in the data-plane of the library. Docs
Milestone
[2021] July

Comments

@KarishmaGhiya
Copy link
Member

As part of readme verification, we would want all headers to have required sections. The package core/logger is missing the following sections:
^Troubleshooting$
^Next steps$

Refer issue : #1583
The packages should have following headers:
Azure .+ client library for JS
^Getting started$
^Key concepts$
^Examples$
^Troubleshooting$
^Next steps$
^Contributing$
@KarishmaGhiya KarishmaGhiya added Client This issue points to a problem in the data-plane of the library. Azure.Core labels Apr 5, 2021
@ramya-rao-a ramya-rao-a added this to the [2021] May milestone Apr 6, 2021
@chradek chradek modified the milestones: [2021] May, [2021] June May 13, 2021
@ramya-rao-a
Copy link
Contributor

Once fixed, remove the exception for this package from https://github.com/Azure/azure-sdk-for-js/blob/master/eng/.docsettings.yml

@ramya-rao-a ramya-rao-a modified the milestones: [2021] June, [2021] July Jun 7, 2021
chradek added a commit to chradek/azure-sdk-for-js that referenced this issue Jun 14, 2021
@chradek
[logger] update README for Azure#14726
9dd7b76
@chradek chradek mentioned this issue Jun 14, 2021
Merged
@ghost ghost closed this as completed in #15734 Jun 15, 2021
ghost pushed a commit that referenced this issue Jun 15, 2021
@chradek
[core] Fix missing readme headers (#15734)
9f65a24 
Fixes #14726 
Fixes #14716 
Fixes #14715 
Fixes #14714
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@chradek chradek

Labels
Azure.Core Client This issue points to a problem in the data-plane of the library. Docs
Projects
None yet
Milestone
[2021] July
Development

Successfully merging a pull request may close this issue.

[core] Fix missing readme headers chradek/azure-sdk-for-js
3 participants
@KarishmaGhiya @ramya-rao-a @chradek