|
| 1 | +# Resources directory |
| 2 | + |
| 3 | +The resource directory at [oursqlfoundation.org/resources/](https://oursqlfoundation.org/resources/) is maintained by the community. Each resource is a single Markdown file in this folder. |
| 4 | + |
| 5 | +There are two ways to contribute. |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +## Option 1 — Pull request |
| 10 | + |
| 11 | +### Folder structure |
| 12 | + |
| 13 | +Pick the folder that matches the resource type: |
| 14 | + |
| 15 | +``` |
| 16 | +content/resources/software/ — open source tools, databases, proxies |
| 17 | +content/resources/saas/ — managed cloud database services |
| 18 | +content/resources/services/ — consulting, support, managed services |
| 19 | +content/resources/training/ — courses, tutorials, certifications |
| 20 | +content/resources/books/ — MySQL books and reference material |
| 21 | +content/resources/events/ — conferences, meetups, community events |
| 22 | +content/resources/community/ — blogs, forums, aggregators, chat |
| 23 | +content/resources/press/ — articles, press releases, coverage |
| 24 | +``` |
| 25 | + |
| 26 | +### File naming |
| 27 | + |
| 28 | +Lowercase letters and hyphens only. No spaces or special characters. |
| 29 | + |
| 30 | +``` |
| 31 | +percona-server-for-mysql.md ✓ |
| 32 | +Percona Server.md ✗ |
| 33 | +``` |
| 34 | + |
| 35 | +### Front matter |
| 36 | + |
| 37 | +Every file needs these fields. Copy an existing file as a starting point. |
| 38 | + |
| 39 | +**All types:** |
| 40 | +```yaml |
| 41 | +--- |
| 42 | +title: "Resource Name" |
| 43 | +link: "https://example.com" |
| 44 | +description: "One or two sentences describing what it is." |
| 45 | +tags: ["tag1", "tag2"] |
| 46 | +--- |
| 47 | +``` |
| 48 | + |
| 49 | +**Events — additional fields:** |
| 50 | +```yaml |
| 51 | +date: 2027-06-01 |
| 52 | +format: "in-person" # or "online" |
| 53 | +city: "Amsterdam" |
| 54 | +country: "Netherlands" |
| 55 | +event_country: ["Netherlands"] |
| 56 | +event_year: ["2027"] |
| 57 | +``` |
| 58 | +
|
| 59 | +**Press & News — additional fields:** |
| 60 | +```yaml |
| 61 | +date: 2026-05-27 |
| 62 | +source: "Publication Name" |
| 63 | +``` |
| 64 | +
|
| 65 | +### Available tags |
| 66 | +
|
| 67 | +| Type | Tags | |
| 68 | +|------|------| |
| 69 | +| Software | `open-source` `server` `proxy` `sharding` | |
| 70 | +| SaaS | `managed` `cloud` `serverless` | |
| 71 | +| Services | `consulting` `support` `enterprise` | |
| 72 | +| Training | `free` `online` `video` `dba` `developer` `certification` | |
| 73 | +| Books | `beginner` `advanced` `practical` `performance` | |
| 74 | +| Events | `conference` `free` `open-source` | |
| 75 | +| Community | `blogs` `news` `forums` `chat` `support` | |
| 76 | +| Press | `news` `press-release` `launch` | |
| 77 | + |
| 78 | +--- |
| 79 | + |
| 80 | +## Option 2 — Open an issue |
| 81 | + |
| 82 | +Not comfortable with Git? Open an issue and describe the resource — someone from the community will add it. |
| 83 | + |
| 84 | +| Type | Issue template | |
| 85 | +|------|---------------| |
| 86 | +| Software | [Add Software resource](https://github.com/OurSQLFoundation/OurSQLFoundation.github.io/issues/new?template=resource-software.yml) | |
| 87 | +| SaaS Solutions | [Add SaaS resource](https://github.com/OurSQLFoundation/OurSQLFoundation.github.io/issues/new?template=resource-saas.yml) | |
| 88 | +| Services | [Add Services resource](https://github.com/OurSQLFoundation/OurSQLFoundation.github.io/issues/new?template=resource-services.yml) | |
| 89 | +| Training | [Add Training resource](https://github.com/OurSQLFoundation/OurSQLFoundation.github.io/issues/new?template=resource-training.yml) | |
| 90 | +| Books | [Add Book](https://github.com/OurSQLFoundation/OurSQLFoundation.github.io/issues/new?template=resource-books.yml) | |
| 91 | +| Events | [Add Event](https://github.com/OurSQLFoundation/OurSQLFoundation.github.io/issues/new?template=resource-events.yml) | |
| 92 | +| Community | [Add Community resource](https://github.com/OurSQLFoundation/OurSQLFoundation.github.io/issues/new?template=resource-community.yml) | |
| 93 | +| Press & News | [Add Press item](https://github.com/OurSQLFoundation/OurSQLFoundation.github.io/issues/new?template=resource-press.yml) | |
| 94 | + |
| 95 | +Not sure which type fits? [Open a general issue](https://github.com/OurSQLFoundation/OurSQLFoundation.github.io/issues/new) and describe it in your own words. |
| 96 | + |
| 97 | +--- |
| 98 | + |
| 99 | +Questions? [contact@oursqlfoundation.org](mailto:contact@oursqlfoundation.org) |
0 commit comments