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: add linters description #3945

Merged
merged 10 commits into from
Jul 11, 2023
Merged

Conversation

AlduLonghi
Copy link
Contributor

@AlduLonghi AlduLonghi commented Jul 9, 2023

What?

resolves #3927

The idea was to add the description for each linter before the snippet in the /linters section.

Additional
I added a formatting function that normalizes all linters' descriptions. This function uppercases the first letter and adds a final dot if missing.

Why?

This is for better understanding so the user doesn't have to scroll all the way up to read the linter's description.

How?

I call the function GetAllSupportedLinterConfigs() and create a map with each linter's name and description. This way I decrease the complexity since I use just one loop to make it and the later search is O(1).

Testing?

Everything is working fine.

Screenshots

From this:
Captura de pantalla 2023-07-09 175357

To this:
Captura de pantalla 2023-07-09 175328

Additional

From this:
Captura de pantalla 2023-07-09 175216

To this:
Captura de pantalla 2023-07-09 175236

Looking forward to your comments :)

@boring-cyborg
Copy link

boring-cyborg bot commented Jul 9, 2023

Hey, thank you for opening your first Pull Request !

@CLAassistant
Copy link

CLAassistant commented Jul 9, 2023

CLA assistant check
All committers have signed the CLA.

@ldez ldez changed the title Add linters description docs: add linters description Jul 10, 2023
@ldez ldez added enhancement New feature or improvement area: docs labels Jul 10, 2023
scripts/expand_website_templates/main.go Outdated Show resolved Hide resolved
scripts/expand_website_templates/main.go Outdated Show resolved Hide resolved
scripts/expand_website_templates/main.go Outdated Show resolved Hide resolved
@ldez ldez added the feedback required Requires additional feedback label Jul 10, 2023
@AlduLonghi AlduLonghi requested a review from ldez July 10, 2023 12:45
@ldez ldez removed the feedback required Requires additional feedback label Jul 11, 2023
Copy link
Member

@ldez ldez left a comment

Choose a reason for hiding this comment

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

Hello,

Thank you for your contribution to our project.
Your PR will benefit many users.

I watched your profile and you seem to have frontend knowledge, we have currently a problem with gatsby in the documentation build (#3864, #3934), can you help us with that?

@AlduLonghi
Copy link
Contributor Author

Hey @ldez! Thank you.

I do have frontend knowledge but I actually never worked with Gatsby before. But let me take a look at the issues and I'll see what I can do about them :)

@ldez ldez merged commit d58f140 into golangci:master Jul 11, 2023
@ldez
Copy link
Member

ldez commented Jul 21, 2023

@AlduLonghi have you taken a look? Can you help us?

If you cannot it's not a problem, I'm just trying to use the opportunity 😺.

@AlduLonghi
Copy link
Contributor Author

Hi @ldez! I've been exploring it the past week and it has to do with Gatsby Migration from v4 to v5. There are some plugins that are not migrated to their latest versions (some needed to be migrated during gatsby migration v3 - v4) and they need code refactoring to function correctly. Is this just this rabbit hole of migrating everything and checking everything works correctly. I might be able to take this next week if that's ok :)

@ldez ldez added this to the v1.54 milestone Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs enhancement New feature or improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add description for linters to website
3 participants