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

chore: move documentation responsibility to website #2335

Merged
merged 4 commits into from
Jan 3, 2024

Conversation

wellwelwel
Copy link
Collaborator

@wellwelwel wellwelwel commented Jan 3, 2024

Finally, the last step from website documentation 🌞✨

  • All responsibility for documentation goes to the website.
  • There are some intentionally duplicated sections (website and README.md):
    • History and Why MySQL2
    • Installation
    • Acknowledgements
    • Contributing
  • No documentation has been changed, it's more about the README.md.

Changes

As mentioned in PR #2279, for this last step there are some changes.

Icons (Badges)

Removing unused badges from README.md:

  • Greenkeeper badge
  • Linux Build
  • Windows Build

Nomenclatures

  • node-mysql2, mysql2, Node MySQL2, Node MySQL 2 and MySQL 2 are now MySQL2.
  • node-mysql, mysqljs and mysqljs/mysql are now Node MySQL and go to https://github.com/mysqljs/mysql every time.

mysqljs organization goes to https://github.com/mysqljs instead of the Node MySQL repository.


Sections

Documentation section (README.md) has been changed to:

Documentation


Dependencies

Firstly, I apologize for the large modification to website's package-lock.json.

Previously, I added the website's dependencies to dependabot check it weekly, but now I've changed it to daily.

Reason: avoid large amounts of PRs at the same time from dependabot, especially when combined to the main project's PRs.

That said, this is why I updated the website's dependencies manually this time.


Sorry for the long wait, I was enjoying some vacation time πŸ™‹πŸ»β€β™‚οΈ

@wellwelwel wellwelwel added documentation website Website features, issues, etc. that aren't directly related to the documentation. labels Jan 3, 2024
@wellwelwel
Copy link
Collaborator Author

wellwelwel commented Jan 3, 2024

Due to the website's package-lock.json, I'll merge it to avoid new exhaustive PRs from dependabot.

@sidorares, please fell free to suggest and ask anything πŸ™‹πŸ»β€β™‚οΈ


Interesting simple topics could be:

  • Icons / Badges such as tests and security status, etc. from master branch
  • Change or add sections (or base it on some documentation you like)
  • Traffic Insights (Google Tag Manager, for example)
  • And anything you like (or that you don't like it either)

@wellwelwel wellwelwel merged commit 956c7ab into sidorares:master Jan 3, 2024
58 checks passed
@wellwelwel wellwelwel deleted the docs-3 branch January 3, 2024 06:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation website Website features, issues, etc. that aren't directly related to the documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant