Skip to content

Commit

Permalink
feat: move /organisations to /organizations
Browse files Browse the repository at this point in the history
  • Loading branch information
10xLaCroixDrinker committed Jan 26, 2025
1 parent 5883724 commit cf4b665
Show file tree
Hide file tree
Showing 16 changed files with 49 additions and 44 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.MD
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing guide

Thanks for your contribution 🥳 to the Fastily website redesign project!
Thanks for your contribution 🥳 to the Fastify website redesign project!

[Code of Conduct](https://github.com/fastify/.github/blob/main/CODE_OF_CONDUCT.md)

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Before we start the development server we will need to fetch some of the docs fr

After installing [GitHub CLI](https://cli.github.com/) ensure you are logged in by running;

```
```bash
gh auth login
```

Expand Down Expand Up @@ -46,7 +46,7 @@ $ npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Note that only the documentations listed in the `versions.json` file will be available. So, if you have a long version list, your local enviroment will be slowed down.
Note that only the documentations listed in the `versions.json` file will be available. So, if you have a long version list, your local environment will be slowed down.

### Deployment

Expand Down
8 changes: 7 additions & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ const config = {
},
{ to: '/ecosystem', label: 'Ecosystem', position: 'left' },
{ to: '/benchmarks', label: 'Benchmarks', position: 'left' },
{ to: '/organisations', label: 'Adopters', position: 'left' },
{ to: '/organizations', label: 'Adopters', position: 'left' },
{ to: '/contribute', label: 'Contribute', position: 'left' },
{ to: '/resources', label: 'Resources', position: 'left' },
{
Expand Down Expand Up @@ -208,6 +208,12 @@ const config = {
// This plugin does not work in dev mode
'@docusaurus/plugin-client-redirects',
{
redirects: [
{
from: '/organisations',
to: '/organizations',
},
],
createRedirects(existingPath) {
// Legacy/Retro compatibility:

Expand Down
4 changes: 2 additions & 2 deletions docusaurus.config.utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ function checkGeneratedData() {
const generatedFiles = [
'static/generated/acknowledgements.json',
'static/generated/benchmarks.json',
'static/generated/organisations.json',
'static/generated/organizations.json',
'static/generated/plugins.json',
'static/generated/team.json',
]
Expand Down Expand Up @@ -98,7 +98,7 @@ function manageRedirects({ existingPath, major, versions, versionsShipped, ignor
return existingPath
.replace(`/docs/${versionName}`, oldPath) // Replace the version with the old path
.replace(/Guides\/(?!Contributing)/g, '') // Remove Guides/ from the path (it has been added in v4)
.replace(/Reference\//g, '') // Remove Refecerence/ from the path (it has been added in v4)
.replace(/Reference\//g, '') // Remove Reference/ from the path (it has been added in v4)
})

// Remove duplicates
Expand Down
4 changes: 2 additions & 2 deletions scripts/build-static-data.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ execute([

// ##### Organizations
{
staticDataFile: path.join(__dirname, '../static/data/organisations.yml'),
outputFile: path.join(__dirname, '../static/generated/organisations.json'),
staticDataFile: path.join(__dirname, '../static/data/organizations.yml'),
outputFile: path.join(__dirname, '../static/generated/organizations.json'),
sideEffect: (data) => {
// Sort alphabetically by `name` lowercase
data.sort((a, b) => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ import React from 'react'
import useBaseUrl from '@docusaurus/useBaseUrl'
import Link from '@docusaurus/Link'

import organizationsData from '@site/static/generated/organisations.json'
import organizationsData from '@site/static/generated/organizations.json'
import styles from './styles.module.css'

export default function Organisations({ maxItems, displayType }) {
export default function Organizations({ maxItems, displayType }) {
const orgs = filterOrganizationsByType(displayType)

return (
<ul className={styles.organisationsList}>
<ul className={styles.organizationsList}>
{shuffle(orgs, { maxItems }).map((organization, index) => (
<li key={index}>
<OrganizationItem organization={organization} />
Expand All @@ -34,7 +34,7 @@ function filterOrganizationsByType(type) {
function OrganizationItem({ organization }) {
return (
<Link href={organization.link} target="_blank" rel="noreferrer" className={getOrganizationStyle(organization)}>
<img src={useBaseUrl(`/img/organisations/${organization.image}`)} alt={`${organization.name} is using Fastify`} />
<img src={useBaseUrl(`/img/organizations/${organization.image}`)} alt={`${organization.name} is using Fastify`} />
</Link>
)
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.organisationsList {
.organizationsList {
margin: 0;
padding: 0;
display: flex;
Expand All @@ -8,39 +8,39 @@
place-items: center center;
}

[data-theme='dark'] .organisationsList {
[data-theme='dark'] .organizationsList {
background-color: var(--ifm-color-secondary-dark);
border-radius: var(--ifm-code-border-radius);
}

.organisationsList li {
.organizationsList li {
align-items: center;
display: flex;
justify-content: center;
margin: 0.6rem;
}

.organisationsList li a {
.organizationsList li a {
text-decoration: none;
}

.organisationsList li a img {
.organizationsList li a img {
filter: grayscale(100%);
transition: all 0.5s;
}

.organisationsList .using img {
.organizationsList .using img {
max-width: 140px;
}

.organisationsList .sponsoring_tier_3 img {
.organizationsList .sponsoring_tier_3 img {
max-width: 140px;
}

.organisationsList .sponsoring_tier_4 img {
.organizationsList .sponsoring_tier_4 img {
max-width: 160px;
}

.organisationsList li a:hover img {
.organizationsList li a:hover img {
filter: none;
}
15 changes: 7 additions & 8 deletions src/pages/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import Layout from '@theme/Layout'
import Link from '@docusaurus/Link'

import HomepageHeader from '@site/src/components/HomePageHeader/index.jsx'
import Organisations from '@site/src/components/Organisations'
import Organizations from '@site/src/components/Organizations'
import Team from '@site/src/components/Team'
import QuickStart from '@site/src/components/QuickStart'
import Heading from '@theme/Heading'
Expand Down Expand Up @@ -43,7 +43,7 @@ export default function Home() {
<p>
Fastify is proudly powering a large ecosystem of organizations and products out there with almost{' '}
<Link to={'https://npm-stat.com/charts.html?package=fastify'}>10 million downloads per month</Link>.{' '}
<Link to="/organisations">Checkout our affiliate companies.</Link>
<Link to="/organizations">Checkout our affiliate companies.</Link>
</p>
</div>

Expand All @@ -55,7 +55,7 @@ export default function Home() {
<Link to="https://github.com/sponsors/fastify">GitHub</Link> or{' '}
<Link to="https://opencollective.com/fastify">Open Collective</Link>.
</p>
<Organisations displayType={'sponsor'} />
<Organizations displayType={'sponsor'} />
</div>
</div>
</section>
Expand Down Expand Up @@ -120,11 +120,10 @@ export default function Home() {
<div className="col col--6">
<Heading as={'h1'}>Ecosystem</Heading>
<p>
Fastify has an ever-growing ecosystem of plugins. There is probably already a plugin for your
favourite database or template language. Have a look at the{' '}
<Link to="/ecosystem">Ecosystem page</Link> to navigate through the currently available plugins.
Can&#39;t you find the plugin you are looking for? No problem,{' '}
<Link to="/docs/latest/Reference/Plugins">it&#39;s very easy to write one</Link>!
Fastify has an ever-growing ecosystem of plugins. There is probably already a plugin for your favorite
database or template language. Have a look at the <Link to="/ecosystem">Ecosystem page</Link> to
navigate through the currently available plugins. Can&#39;t you find the plugin you are looking for?
No problem, <Link to="/docs/latest/Reference/Plugins">it&#39;s very easy to write one</Link>!
</p>
<p>
<Link to="/ecosystem" className="button button--lg button--primary">
Expand Down
30 changes: 15 additions & 15 deletions src/pages/organisations.mdx → src/pages/organizations.mdx
Original file line number Diff line number Diff line change
@@ -1,50 +1,50 @@
import HeroBanner from '@site/src/components/HeroBanner'
import Organisations from '@site/src/components/Organisations'
import Organizations from '@site/src/components/Organizations'

<HeroBanner title="Organisations using Fastify" />
<HeroBanner title="Organizations using Fastify" />

Fastify is proudly powering a large ecosystem of organisations and products out there.
Fastify is proudly powering a large ecosystem of organizations and products out there.

Below is a list of our financial supporters and our collaborators' organisations adopting Fastify.
Below is a list of our financial supporters and our collaborators' organizations adopting Fastify.

## Financial supporters

<Organisations displayType="sponsor" />
<Organizations displayType="sponsor" />

## Collaborators' organisations
## Collaborators' organizations

<Organisations displayType="collaborator" />
<Organizations displayType="collaborator" />

_The logos displayed in this page are property of the respective organisations and they are not distributed under the same license as Fastify (MIT)._
_The logos displayed in this page are property of the respective organizations and they are not distributed under the same license as Fastify (MIT)._

## How to be featured here

Is your organisation using Fastify? That's great!
Is your organization using Fastify? That's great!

If you would like your organisation to have its logo featured in this list:
If you would like your organization to have its logo featured in this list:

1. Start contributing to the Fastify project following the [contributing guide](https://github.com/fastify/fastify/blob/main/CONTRIBUTING.md) and read the [on boarding process](https://github.com/fastify/.github/blob/main/GOVERNANCE.md#collaborator-nominations).

Or become a [Tier 3 or 4 financial supporter](https://github.com/sponsors/fastify)!

2. Fork the [Fastify website repository](https://github.com/fastify/website) on GitHub

3. Add the logo in the `static/img/organisations` folder.
3. Add the logo in the `static/img/organizations` folder.

Please make sure that your logo complies to the following specs:

- Encoded in SVG (Scalable Vector Graphics) format
- Be reasonably optimized/minified _(you can use [imageOptim](https://imageoptim.com/))_
- Make sure image "width" or "height" are explicitly specified in the "svg" tag

3. Update the `static/data/organisations.yml` file with a new entry
3. Update the `static/data/organizations.yml` file with a new entry

Your entry must provide:

- `name`: the name of your organisation
- `name`: the name of your organization
- `image`: the filename of the logo you added in the previous step
- `link`: a link to a website that represents your organisation
- `sponsor`: a boolean value that indicates if your organisation is a financial supporter
- `link`: a link to a website that represents your organization
- `sponsor`: a boolean value that indicates if your organization is a financial supporter
- `tier`: the tier of your financial support (it can be `tier_3` or `tier_4`)

4. Submit the PR!
Expand Down
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes

0 comments on commit cf4b665

Please sign in to comment.