From 2a161596703ad80bda4bed0073a20c913b2d9c99 Mon Sep 17 00:00:00 2001 From: Gabriel Roldan Date: Sat, 6 Dec 2025 19:53:22 -0300 Subject: [PATCH] docs: Add All Contributors page to recognize all contribution types Implement the All Contributors initiative in the documentation to recognize contributions of all kinds - not just code. This includes business development, project management, financial support, user testing, and more. - Add .all-contributorsrc configuration file at project root - Create new Community section in documentation - docs/src/community/index.md - Community landing page - docs/src/community/contributors.md - All Contributors page - Update docs/mkdocs.yml navigation to include Community section - Configure htmlproofer to ignore contributors page (has dynamic anchor links) - Add initial contributors with their contribution types How to add contributors: Install the CLI (one-time setup): ``` npm install --save-dev all-contributors-cli npx all-contributors-cli add npx all-contributors-cli add username code,doc,test,bug ``` --- .all-contributorsrc | 281 ++++++++++++++++++ .gitignore | 5 +- docs/mkdocs.yml | 7 +- .../assets/images/geoserver-logo-outline.svg | 182 ++++++++++++ docs/src/assets/images/geoserver-logo.svg | 182 ++++++++++++ docs/src/assets/stylesheets/extra.css | 18 +- docs/src/community/contributors.md | 121 ++++++++ docs/src/community/index.md | 56 ++++ 8 files changed, 847 insertions(+), 5 deletions(-) create mode 100644 .all-contributorsrc create mode 100644 docs/src/assets/images/geoserver-logo-outline.svg create mode 100644 docs/src/assets/images/geoserver-logo.svg create mode 100644 docs/src/community/contributors.md create mode 100644 docs/src/community/index.md diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 00000000..6f1b7830 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,281 @@ +{ + "projectName": "geoserver-cloud", + "projectOwner": "geoserver", + "repoType": "github", + "repoHost": "https://github.com", + "files": [ + "docs/src/community/contributors.md" + ], + "imageSize": 120, + "commit": false, + "commitConvention": "none", + "contributors": [ + { + "login": "groldan", + "name": "Gabriel Roldan", + "avatar_url": "https://avatars.githubusercontent.com/u/207423?v=4", + "profile": "https://github.com/groldan", + "contributions": [ + "code", + "doc", + "infra", + "design", + "ideas", + "maintenance", + "research", + "talk" + ] + }, + { + "login": "vuilleumierc", + "name": "CΓ©cile Vuilleumier", + "avatar_url": "https://avatars.githubusercontent.com/u/18527151?v=4", + "profile": "https://github.com/vuilleumierc", + "contributions": [ + "code", + "bug", + "test", + "infra", + "review" + ] + }, + { + "login": "jemacchi", + "name": "Jose Macchi", + "avatar_url": "https://avatars.githubusercontent.com/u/1171099?v=4", + "profile": "http://josemacchi.wordpress.com/", + "contributions": [ + "bug", + "test", + "infra", + "review" + ] + }, + { + "login": "danduk82", + "name": "Andrea Borghi", + "avatar_url": "https://avatars.githubusercontent.com/u/2493436?v=4", + "profile": "https://github.com/danduk82", + "contributions": [ + "infra", + "bug", + "test", + "code", + "talk", + "userTesting" + ] + }, + { + "login": "buehner", + "name": "Nils BΓΌhner", + "avatar_url": "https://avatars.githubusercontent.com/u/3939332?v=4", + "profile": "http://www.terrestris.de/", + "contributions": [ + "code", + "plugin", + "bug", + "test", + "talk" + ] + }, + { + "login": "dnlkoch", + "name": "Daniel Koch", + "avatar_url": "https://avatars.githubusercontent.com/u/1137620?v=4", + "profile": "https://www.terrestris.de/", + "contributions": [ + "code", + "plugin", + "bug", + "test", + "talk" + ] + }, + { + "login": "AlexGacon", + "name": "Alexandre Gacon", + "avatar_url": "https://avatars.githubusercontent.com/u/3034717?v=4", + "profile": "https://github.com/AlexGacon", + "contributions": [ + "doc", + "bug", + "test", + "ideas", + "question", + "translation" + ] + }, + { + "login": "woutergd", + "name": "Wouter Goedhart", + "avatar_url": "https://avatars.githubusercontent.com/u/12986656?v=4", + "profile": "https://github.com/woutergd", + "contributions": [ + "bug", + "plugin", + "code" + ] + }, + { + "login": "guspan-tanadi", + "name": "Guspan Tanadi", + "avatar_url": "https://avatars.githubusercontent.com/u/36249910?v=4", + "profile": "https://github.com/guspan-tanadi", + "contributions": [ + "doc" + ] + }, + { + "login": "cryptobioz", + "name": "LΓ©o Depriester", + "avatar_url": "https://avatars.githubusercontent.com/u/7858427?v=4", + "profile": "https://exadot.fr/", + "contributions": [ + "infra" + ] + }, + { + "login": "jwkaltz", + "name": "Wolfgang Kaltz", + "avatar_url": "https://avatars.githubusercontent.com/u/9261252?v=4", + "profile": "https://github.com/jwkaltz", + "contributions": [ + "doc", + "projectManagement", + "business", + "promotion" + ] + }, + { + "login": "ppradela", + "name": "Przemyslaw Pradela", + "avatar_url": "https://avatars.githubusercontent.com/u/51158576?v=4", + "profile": "https://pradela.ovh/", + "contributions": [ + "doc" + ] + }, + { + "login": "shacharmo", + "name": "shacharmo", + "avatar_url": "https://avatars.githubusercontent.com/u/5156570?v=4", + "profile": "https://github.com/shacharmo", + "contributions": [ + "bug", + "code" + ] + }, + { + "login": "allanin", + "name": "allanin", + "avatar_url": "https://avatars.githubusercontent.com/u/29509022?v=4", + "profile": "https://github.com/allanin", + "contributions": [ + "doc", + "test" + ] + }, + { + "login": "marcjansen", + "name": "Marc Jansen", + "avatar_url": "https://avatars.githubusercontent.com/u/227934?v=4", + "profile": "https://terrestris.de/", + "contributions": [ + "doc", + "userTesting" + ] + }, + { + "login": "longtomjr", + "name": "Herman", + "avatar_url": "https://avatars.githubusercontent.com/u/3615508?v=4", + "profile": "https://github.com/longtomjr", + "contributions": [ + "doc", + "userTesting", + "bug" + ] + }, + { + "login": "jahow", + "name": "Olivia Guyot", + "avatar_url": "https://avatars.githubusercontent.com/u/10629150?v=4", + "profile": "https://github.com/jahow", + "contributions": [ + "doc", + "userTesting", + "bug", + "code" + ] + }, + { + "login": "pmauduit", + "name": "Pierre Mauduit", + "avatar_url": "https://avatars.githubusercontent.com/u/594335?v=4", + "profile": "https://github.com/pmauduit", + "contributions": [ + "doc", + "userTesting", + "bug", + "code" + ] + }, + { + "login": "mlechner", + "name": "Marco Lechner", + "avatar_url": "https://avatars.githubusercontent.com/u/1194826?v=4", + "profile": "https://github.com/mlechner", + "contributions": [ + "userTesting" + ] + }, + { + "login": "MkLHX", + "name": "Mickael Lehoux", + "avatar_url": "https://avatars.githubusercontent.com/u/17542841?v=4", + "profile": "https://github.com/MkLHX", + "contributions": [ + "bug", + "userTesting" + ] + }, + { + "login": "ebelo", + "name": "Emmanuel Belo", + "avatar_url": "https://avatars.githubusercontent.com/u/496153?v=4", + "profile": "https://www.camptocamp.com/", + "contributions": [ + "fundingFinding", + "promotion", + "business" + ] + }, + { + "login": "fgravin", + "name": "Florent Gravin", + "avatar_url": "https://avatars.githubusercontent.com/u/1491924?v=4", + "profile": "https://github.com/fgravin", + "contributions": [ + "business", + "ideas", + "promotion", + "fundingFinding" + ] + }, + { + "login": "AdrienVH-c2c", + "name": "Adrien VAN HAMME", + "avatar_url": "https://avatars.githubusercontent.com/u/62234831?v=4", + "profile": "https://www.camptocamp.com/solutions/geospatial/", + "contributions": [ + "business", + "ideas", + "promotion", + "fundingFinding" + ] + } + ], + "contributorsPerLine": 7, + "skipCi": true, + "contributorsSortAlphabetically": true +} diff --git a/.gitignore b/.gitignore index 073ae761..51e17084 100644 --- a/.gitignore +++ b/.gitignore @@ -46,4 +46,7 @@ hs_err_pid*.log .spotless-index -.venv \ No newline at end of file +.venv +node_modules +package-lock.json +package.json diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index ee08c9d3..cb4d7deb 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -10,7 +10,7 @@ docs_dir: src theme: name: material custom_dir: overrides - logo: assets/images/geoserver-logo.png + logo: assets/images/geoserver-logo-outline.svg favicon: assets/images/favicon.ico features: - navigation.tabs @@ -93,6 +93,8 @@ plugins: raise_error_after_finish: false validate_external_urls: false validate_rendered_template: true + ignore_pages: + - community/contributors.md - minify: minify_html: true @@ -105,6 +107,9 @@ nav: - Configuration: - Externalized configuration guide: configuration/index.md - Migration 2.26 to 2.27: configuration/migration-2.26-to-2.27.md + - Community: + - Overview: community/index.md + - Contributors: community/contributors.md - Developer Guide: - Overview: developer-guide/index.md - Building: developer-guide/build_instructions.md diff --git a/docs/src/assets/images/geoserver-logo-outline.svg b/docs/src/assets/images/geoserver-logo-outline.svg new file mode 100644 index 00000000..050b425c --- /dev/null +++ b/docs/src/assets/images/geoserver-logo-outline.svg @@ -0,0 +1,182 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/src/assets/images/geoserver-logo.svg b/docs/src/assets/images/geoserver-logo.svg new file mode 100644 index 00000000..eabfb6a0 --- /dev/null +++ b/docs/src/assets/images/geoserver-logo.svg @@ -0,0 +1,182 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/src/assets/stylesheets/extra.css b/docs/src/assets/stylesheets/extra.css index 467af2cd..833827a2 100644 --- a/docs/src/assets/stylesheets/extra.css +++ b/docs/src/assets/stylesheets/extra.css @@ -210,19 +210,31 @@ body { /* Dark mode adjustments */ [data-md-color-scheme="slate"] { - /* Revert header to dark for slate mode if desired, or keep custom. + /* Revert header to dark for slate mode if desired, or keep custom. Usually slate mode expects dark header. */ --md-header-bg: #1e1e20; /* Default slate header */ --md-header-fg: var(--md-primary-fg-color); - + .grid.cards > .card { border-color: var(--md-default-fg-color--lightest); background-color: var(--md-default-bg-color); } - + .performance-table th { background-color: var(--md-code-bg-color); } + + /* Search input visibility on dark header */ + .md-search__input { + background-color: rgba(255, 255, 255, 0.12); + color: var(--md-default-fg-color); + } + .md-search__input:hover { + background-color: rgba(255, 255, 255, 0.18); + } + .md-search__input::placeholder { + color: rgba(255, 255, 255, 0.54); + } } /* Print styles */ diff --git a/docs/src/community/contributors.md b/docs/src/community/contributors.md new file mode 100644 index 00000000..99ef13a7 --- /dev/null +++ b/docs/src/community/contributors.md @@ -0,0 +1,121 @@ +# Contributors + +This project follows the [All Contributors](https://allcontributors.org) specification. We recognize contributions of all kinds - not just code! + +## Our Amazing Contributors + +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Adrien VAN HAMME
Adrien VAN HAMME
πŸ’Ό πŸ€” πŸ“£ πŸ”		Alexandre Gacon
Alexandre Gacon
πŸ“– πŸ› ⚠️ πŸ€” πŸ’¬ 🌍		Andrea Borghi
Andrea Borghi
πŸš‡ πŸ› ⚠️ πŸ’» πŸ“’ πŸ““		CΓ©cile Vuilleumier
CΓ©cile Vuilleumier
πŸ’» πŸ› ⚠️ πŸš‡ πŸ‘€		Daniel Koch
Daniel Koch
πŸ’» πŸ”Œ πŸ› ⚠️ πŸ“’		Emmanuel Belo
Emmanuel Belo
πŸ” πŸ“£ πŸ’Ό		Florent Gravin
Florent Gravin
πŸ’Ό πŸ€” πŸ“£ πŸ”
Gabriel Roldan
Gabriel Roldan
πŸ’» πŸ“– πŸš‡ 🎨 πŸ€” 🚧 πŸ”¬ πŸ“’		Guspan Tanadi
Guspan Tanadi
πŸ“–		Herman
Herman
πŸ“– πŸ““ πŸ›		Jose Macchi
Jose Macchi
πŸ› ⚠️ πŸš‡ πŸ‘€		LΓ©o Depriester
LΓ©o Depriester
πŸš‡		Marc Jansen
Marc Jansen
πŸ“– πŸ““		Marco Lechner
Marco Lechner
πŸ““
Mickael Lehoux
Mickael Lehoux
πŸ› πŸ““		Nils BΓΌhner
Nils BΓΌhner
πŸ’» πŸ”Œ πŸ› ⚠️ πŸ“’		Olivia Guyot
Olivia Guyot
πŸ“– πŸ““ πŸ› πŸ’»		Pierre Mauduit
Pierre Mauduit
πŸ“– πŸ““ πŸ› πŸ’»		Przemyslaw Pradela
Przemyslaw Pradela
πŸ“–		Wolfgang Kaltz
Wolfgang Kaltz
πŸ“– πŸ“† πŸ’Ό πŸ“£		Wouter Goedhart
Wouter Goedhart
πŸ› πŸ”Œ πŸ’»
allanin
allanin
πŸ“– ⚠️		shacharmo
shacharmo
πŸ› πŸ’»
+ + + + + + +## How to Get Recognized + +We use the All Contributors bot to recognize contributors. There are two ways to be added: + +### For Code & GitHub Activity + +If you've contributed through GitHub (code, issues, reviews, etc.), you can request to be added: + +1. Comment on any issue or PR: `@all-contributors please add @username for ` +2. The bot will create a PR adding you to the list +3. Once merged, you'll appear on this page! + +**Contribution types include:** + +| Type | Emoji | Description | +|------|-------|-------------| +| code | πŸ’» | Code contributions | +| doc | πŸ“– | Documentation | +| bug | πŸ› | Bug reports | +| test | ⚠️ | Tests | +| infra | πŸš‡ | Infrastructure (CI/CD, build tools, etc.) | +| design | 🎨 | Design work | +| ideas | πŸ€” | Ideas & Planning | +| review | πŸ‘€ | Code reviews | +| question | πŸ’¬ | Answering questions | +| maintenance | 🚧 | Maintenance | +| example | πŸ’‘ | Examples | +| tutorial | βœ… | Tutorials | +| translation | 🌍 | Translation | +| talk | πŸ“’ | Talks & presentations | +| video | πŸ“Ή | Videos | +| plugin | πŸ”Œ | Plugin development | +| userTesting | πŸ““ | User testing | +| content | πŸ–‹ | Content creation | +| eventOrganizing | πŸ“‹ | Event organizing | +| mentoring | πŸ§‘β€πŸ« | Mentoring | +| research | πŸ”¬ | Research | +| business | πŸ’Ό | Business development | +| financial | πŸ’΅ | Financial support | +| projectManagement | πŸ“† | Project management | +| promotion | πŸ“£ | Promoting the project | +| security | πŸ›‘οΈ | Security work | +| fundingFinding | πŸ” | Funding finding | + +See the complete list at [allcontributors.org/emoji-key](https://allcontributors.org/emoji-key). + +### Manual Addition + +Some contributions (like business development, financial support, or project management) may not show up in GitHub activity. For these contributions, contact the maintainers to be manually added to the `.all-contributorsrc` file. + +## Why All Contributors? + +We believe that **all contributions matter**. Whether you: + +- Fixed a typo in the docs +- Reported a critical bug +- Answered a question on GitHub +- Gave a talk about GeoServer Cloud +- Provided financial support +- Managed project priorities +- Or anything else that helped the project + +**You deserve recognition!** πŸŽ‰ + +This page celebrates everyone who has helped make GeoServer Cloud better. Thank you! + +--- + +*This project follows the [All Contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!* diff --git a/docs/src/community/index.md b/docs/src/community/index.md new file mode 100644 index 00000000..0ed6bcc3 --- /dev/null +++ b/docs/src/community/index.md @@ -0,0 +1,56 @@ +# Community + +Welcome to the GeoServer Cloud community! We're glad you're here. + +GeoServer Cloud is an open-source project that thrives on community collaboration. Whether you're a developer, user, tester, designer, or advocate, there's a place for you here. + +## Get Involved + +There are many ways to contribute to GeoServer Cloud: + +- **Report bugs** and request features through [GitHub Issues](https://github.com/geoserver/geoserver-cloud/issues) +- **Contribute code** by submitting pull requests +- **Improve documentation** to help others understand and use GeoServer Cloud +- **Answer questions** and help other users +- **Test new features** and provide feedback +- **Share your experience** through blog posts, talks, or social media +- **Support the project** financially or through business partnerships + +## Community Resources + +### [Contributors](contributors.md) +See our amazing contributors who make this project possible. We recognize all types of contributions, not just code! + +### [Contributing Guide](https://github.com/geoserver/geoserver-cloud/blob/main/CONTRIBUTING.md) +Learn how to contribute to GeoServer Cloud, including: + +- Pull request workflow +- Commit guidelines +- Code contribution license agreement +- Development setup + +### [Code of Conduct](https://github.com/geoserver/geoserver-cloud/blob/main/CODE_OF_CONDUCT.md) +Our community pledge and standards for inclusive, welcoming participation. + +### Communication + +- **GitHub Discussions**: Ask questions, share ideas, and discuss the project +- **GitHub Issues**: Report bugs and request features +- **Pull Requests**: Contribute code and documentation + +## Recognition + +We believe that all contributions are valuable. That's why we use the [All Contributors](https://allcontributors.org) specification to recognize everyone who contributes to the project, regardless of the type of contribution. + +Visit our [Contributors page](contributors.md) to see everyone who has helped make GeoServer Cloud better! + +## Support + +If you need help: + +1. Check the [documentation](../index.md) for guides and references +2. Search [existing issues](https://github.com/geoserver/geoserver-cloud/issues) to see if your question has been answered +3. Open a new issue if you've found a bug or have a feature request +4. Reach out to the community through GitHub Discussions + +Thank you for being part of the GeoServer Cloud community!