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

Spelling related question - huge amount of fixes to contribute. #124754

Open
ArieHein opened this issue Oct 30, 2024 · 12 comments
Open

Spelling related question - huge amount of fixes to contribute. #124754

ArieHein opened this issue Oct 30, 2024 · 12 comments

Comments

@ArieHein
Copy link

Like i do at this time of the year, and already did to some of the documentation sites for tools and tech i use, its time for the spelling bee to contribute back...alas...I have gone over i think 20% of the entire rpeo, and have over 300 spelling fixes.
At this rate i will pass 1000 fixes.

Obviously i cant and wont send it all in one pull request.
Is there a specific way you would prefer me to split it, so you guys dont kill yourself for having to review too much at once ?

@TPavanBalaji
Copy link
Contributor

@ArieHein
It would be great if you could add a link to the documentation you are following for these steps? This would help us redirect the issue to the appropriate team. Thanks!

@ArieHein
Copy link
Author

ArieHein commented Nov 1, 2024

Not sure i follow you there.

These are spelling mistakes across quite a lot of sub folders in the articles and the includes which will end up in over 50 pull requests if i split it per folder (probably more). I'm looking for insight on how to break it so its easier for you guys to review.

@TPavanBalaji
Copy link
Contributor

@ArieHein
Please Note, GitHub forum is dedicated for Microsoft documentation related issues. So kindly share Microsoft document link which you are following for these steps.

@ArieHein
Copy link
Author

ArieHein commented Nov 4, 2024

I'm following the contribution guide that is in this repo, that leads you to the general Learn contribution pages, so im not sure what you are asking. None of them, though, discuss my question.

My question was quite simple. I have now reached around 700 files that have at least one spelling fix
image

So question is simple, one pull request would be a huge problem to review for you (?).
Breaking it in to, say topics, might be better but then its about 100 topics so 100 pull requests. This will flood the existing pull requests list of others, so not a nice etiquette.

@ArieHein
Copy link
Author

ArieHein commented Nov 4, 2024

Have the same issues with the sql-docs, with only 181 spelling fixes, but at least there, its over 7 main chapters, so opening 7 PRs isnt too much to "flood" the existing 6 requests.

@TPavanBalaji
Copy link
Contributor

@ArieHein
Thanks for your feedback and your contribution to Azure docs.
Feedback for this repository is moving away from GitHub to a system specific to the Microsoft Learn platform. Issues for this repository will soon be disabled, and additional comments from GitHub will no longer be possible. However, we are now tracking and triaging this issue in the new feedback system.
To learn more about our feedback systems, please see
Provide feedback for Microsoft Learn content
.

@ArieHein
Copy link
Author

ArieHein commented Nov 5, 2024

@TPavanBalaji I know the issues are going away but the pull requests are not.

None of the documentation answers my questions so this is why i hoped to get some sort of support here.
I now have above 180 fixes as well for the sql-docs. While in the sql-doc repo, its about 7 main chapters, i can create 7 new PRs (doubling the 6 they have now) but i cant do the same for the azure one as were talking about 100 chapters, only that means 100 pull requests. i would have followed the owners page but that file is broken and doesnt cover all the chapters

I have to say, so far this has been a very poor level of interaction. None of your comments actually deals with my questions and you end up closing the issue.

@JasonWHowell, @thomps23 , Do you have any ideas about this topic to make it both easier for you to review (as you both are owners of at least half the chapters that i can see) and on the other hand not spam the pull request with 2 full pages ?

@JasonWHowell
Copy link
Contributor

@ArieHein
Can you please give some examples of what kind of spelling fixes you are intending to make?

We have automation for such things, so while we appreciate the help, it can be done in a fashion without requiring manual reviews by hundreds of individuals. If it's just a couple of words, it can be done in a batch by the automation.

I'm not sure what you mean "chapters". Can you please clarify.

Thanks, Jason

@ArieHein
Copy link
Author

ArieHein commented Nov 6, 2024

@JasonWHowell Thank you for picking this up, appreicated.

Chapters are the sub folders under the articles or includes top folders, for example 'azure-sql-edge', 'azure-vmware' as in the picture i have added here, are a chapter, for lack of better word. Sometimes, there would be maybe just one file that needs a change in a chapter, sometimes multiple, and sometimes more than one fix in the same file.
The picture shows an example of a fix in one of the files.

image

Since i have about 100 of these chapters, that's 100 pull requests, which is why im looking for your insights into how to do it correctly.

more examples:

Original: "...build on thePpython apps..."
Fixed: "...build on the Python apps..."

image

Original: "...must be either connecticity or..."
Fixed: "...must be either connectivity or..."

image

Hope this gives you a glimpse about the scale of this...i have weird hobbies over weekends :)
(im doing this effort to many repos, PowerShell docs, azure docs, sql docs, github docs and other techs that i frequently use )

@JasonWHowell
Copy link
Contributor

That's a noble task. Thanks for the help.

I think we have a conference coming up at Ignite starting Nov 19th, and a lot of content usually changes at conferences. I recommend waiting until after that time to start on any changes, else conflicts are likely to arise, and the changes rejected.

Let's check with @Court72 on logistics of what she prefers since she's triaging most of the incoming pull requests. Since the changes are spelling typos then we likely don't require a major tech review to get things merged. More of a quick editorial look.

I'd call those chapters "service-folders" - one Azure service per folder. There are 158 folders under /articles/ in azure-docs public repo, and 12 folders+1574 files under includes. Other azure-docs-* repos should be less complex (~10 folders or less a piece).

As long as it's just simple spelling/typos, maybe it'd be sufficient to batch changes 10 (or 100?) files at a time per service-folder. What do you think @Court72

Thanks, Jason

@ArieHein
Copy link
Author

ArieHein commented Nov 6, 2024

Thanks Jason,

Usually what comes from ignite is an influx of NEW content to fix :)

Luckily for me, or Courtney, not all service-folders require fixes to spelling or i would be worried :)
Per service-folder was also in my list but that will create 100 PRs, some small some big which will flood the PR tab and i dont consider that very nice from an etiquette perspective :)

@JasonWHowell
Copy link
Contributor

I would still like @Court72 72 to weigh in on the PR file size. 10 is probably better than 100?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants