Skip to content

Commit 810258f

Browse files
authored
update CONTRIBUTING.md, install instructions, file structure, replace gatsby by nextra mentions (graphql#1654)
* update CONTRIBUTING.md * update CONTRIBUTING.md
1 parent df21f36 commit 810258f

File tree

3 files changed

+33
-35
lines changed

3 files changed

+33
-35
lines changed

CONTRIBUTING.md

+29-31
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing to graphql.org
22

3-
> This repository is governed by the [GraphQL Code of Conduct](https://graphql.org/codeofconduct/). By contributing, you agree to abide by its terms.
3+
> This repository is governed by the [GraphQL Code of Conduct](https://graphql.org/codeofconduct). By contributing, you agree to abide by its terms.
44
55
Thanks for taking the time to contribute! The GraphQL community is great because of people like you 🎉
66

@@ -30,43 +30,41 @@ There are many ways to get involved. Follow this guide and feel free to [reach o
3030

3131
First, clone this repository and move into the directory:
3232

33-
```bash
33+
```sh
3434
git clone https://github.com/graphql/graphql.github.io.git
3535
cd graphql.github.io
3636
```
3737

38-
Then, use [Yarn](https://yarnpkg.com/getting-started/install) to install and load all the necessary dependencies:
38+
Then, use [pnpm](https://pnpm.io) to install and load all the necessary dependencies:
3939

40-
```bash
41-
yarn
40+
```sh
41+
pnpm i
4242
```
4343

44-
> Note: [Yarn is currently the only way to run the site locally](https://github.com/graphql/graphql.github.io/issues/946).
44+
> Note: [pnpm is currently the only way to run the site locally](https://github.com/graphql/graphql.github.io/issues/946).
4545
46-
Run the `start` script to launch the server:
46+
Run the `dev` script to launch the server:
4747

48-
```bash
49-
yarn start
48+
```sh
49+
pnpm dev
5050
```
5151

52-
Finally, open http://localhost:8000 to view it in the browser.
52+
Finally, open http://localhost:3000 to view it in the browser.
5353

54-
The GraphQL website is built with [Gatsby](https://gatsbyjs.com/docs). This means that a hot-reloading development environment will be accessible by default.
54+
The GraphQL website is built with [Nextra](https://nextra.site). This means that a hot-reloading development environment will be accessible by default.
5555

5656
### Branching
5757

5858
Active development for graphql.org happens on the `source` branch. Be sure to create any new branches or direct any pull requests back to `source`.
5959

6060
### Project structure
6161

62-
- `static`: Files that will be copied directly to `public`.
63-
- `public`: Output files that will be served by a static HTTP server.
64-
- `src`: Markdown and the TypeScript/JavaScript files used to generate the website.
65-
- `assets`: All the [`less`](http://lesscss.org/) files that contain stylesheets.
66-
- `components` and `Containers`: React components used for layouts and pages.
67-
- `content`: Markdown files with the content of pages.
68-
- `templates`: Layout templates.
69-
- `utils`: Helper functions.
62+
- `public`: Static files, like images, can be referenced by your code starting from the base URL (`/`)
63+
- `out`: Output files that will be served by a static HTTP server
64+
- `src`: Markdown and the TypeScript/JavaScript files used to generate the website
65+
- `app`: A new App Router built on React Server Components which supports shared layouts, nested routing, loading states, error handling, and more
66+
- `pages`: A file-system based router, when a file is added to the `pages` directory, it's automatically available as a route
67+
- `components`: React components used for pages
7068

7169
### Publishing the updated site
7270

@@ -78,11 +76,11 @@ Your changes will be merged into the `source` branch. Then, the CI will automati
7876

7977
If you notice something wrong in the text or code samples, please follow our [development guide](#development-guide) to [open a pull request](https://github.com/graphql/graphql.github.io/pulls) with your fix.
8078

81-
All of the content on graphql.org is written and formatted in [Markdown](https://www.gatsbyjs.com/docs/mdx/markdown-syntax/).
79+
All of the content on https://graphql.org is written and formatted in [Markdown](https://nextra.site/docs/guide/markdown).
8280

8381
### Add a library, tool, or service to the Code page
8482

85-
The [Code page](https://graphql.org/code/) is a collection of libraries, tools, and services built for GraphQL.
83+
The [Code page](https://graphql.org/code) is a collection of libraries, tools, and services built for GraphQL.
8684

8785
#### General guidelines
8886

@@ -107,39 +105,39 @@ We rely on these concrete signals before removing a resource. Even if a project
107105

108106
To add or remove a resource to this page, follow our [development guide](#development-guide) to [open a pull request](https://github.com/graphql/graphql.github.io/pulls).
109107

110-
The content for this page is located in [various directories under `src/content/code`](./src/). Everything is written and formatted in [Markdown](https://www.gatsbyjs.com/docs/mdx/markdown-syntax/).
108+
The content for this page is located in [various directories under `src/code`](./src/code). Everything is written and formatted in [Markdown](https://nextra.site/docs/guide/markdown).
111109

112110
### Add a resource to the Community page
113111

114-
The [Community page](https://graphql.org/community/) highlights resources and groups that help people get more involved with GraphQL.
112+
The [Community page](https://graphql.org/community) highlights resources and groups that help people get more involved with GraphQL.
115113

116114
To add something to this page, follow our [development guide](#development-guide) to [open a pull request](https://github.com/graphql/graphql.github.io/pulls).
117115

118-
The content for this page is located in a [directory under `src/content/community`](./src/). Everything is written and formatted in [Markdown](https://www.gatsbyjs.com/docs/mdx/markdown-syntax/).
116+
The content for this page is located in a [directory under `src/pages/community`](./src/pages/community). Everything is written and formatted in [Markdown](https://nextra.site/docs/guide/markdown).
119117

120118
### Add a question to the FAQ
121119

122-
Our [Frequently Asked Questions (FAQ) page](https://graphql.org/faq/) is designed to help answer questions from the community. This page is still in development, so if you think there's a question missing - please [open an issue](https://github.com/graphql/graphql.github.io/issues/new)! It'd be great if you could include both the question and a proposed answer outline in the issue description.
120+
Our [Frequently Asked Questions (FAQ) page](https://graphql.org/faq) is designed to help answer questions from the community. This page is still in development, so if you think there's a question missing - please [open an issue](https://github.com/graphql/graphql.github.io/issues/new)! It'd be great if you could include both the question and a proposed answer outline in the issue description.
123121

124-
Once you have approval from a maintainer, use the [development guide](#development-guide) to add your question and answer. The content for the FAQ is located in [`src/content/faq`](./src/content/faq/). Each section has its own [Markdown](https://www.gatsbyjs.com/docs/mdx/markdown-syntax/) file.
122+
Once you have approval from a maintainer, use the [development guide](#development-guide) to add your question and answer. The content for the FAQ is located in [`src/pages/faq`](./src/pages/faq). Each section has its own [Markdown](https://nextra.site/docs/guide/markdown) file.
125123

126124
> Note: All answers in this section should be vendor-neutral and accessible to GraphQL users of all levels.
127125
128-
When your answer is ready, [open a pull request](https://github.com/graphql/graphql.github.io/pulls/).
126+
When your answer is ready, [open a pull request](https://github.com/graphql/graphql.github.io/pulls).
129127

130128
### Write a new section or guide
131129

132130
There are still several [Best Practices guides that no one has written](https://github.com/graphql/graphql.github.io/issues/41) yet. If you want to take one of these, comment on [the original issue](https://github.com/graphql/graphql.github.io/issues/41) and mention which topic you'll work on.
133131

134-
Then, use our [development guide](#development-guide) to determine where your new page best fits. Our documentation is written and formatted in [Markdown](https://www.gatsbyjs.com/docs/mdx/markdown-syntax/).
132+
Then, use our [development guide](#development-guide) to determine where your new page best fits. Our documentation is written and formatted in [Markdown](https://nextra.site/docs/guide/markdown).
135133

136-
Once it's ready for review, please [open a pull request](https://github.com/graphql/graphql.github.io/pulls/).
134+
Once it's ready for review, please [open a pull request](https://github.com/graphql/graphql.github.io/pulls).
137135

138136
## Making changes to the code
139137

140138
Before diving into any code updates, please [open an issue](https://github.com/graphql/graphql.github.io/issues/new) describing the change(s) you'd like to make.
141139

142-
If you're working off an [existing issue](https://github.com/graphql/graphql.github.io/issues/), follow our [development guide](#development-guide) to make your changes. Once it's ready for review, please [open a pull request](https://github.com/graphql/graphql.github.io/pulls/) and reference the original issue.
140+
If you're working off an [existing issue](https://github.com/graphql/graphql.github.io/issues), follow our [development guide](#development-guide) to make your changes. Once it's ready for review, please [open a pull request](https://github.com/graphql/graphql.github.io/pulls) and reference the original issue.
143141

144142
### Browser support
145143

@@ -157,7 +155,7 @@ If you run into any problems or have questions while contributing, you're always
157155

158156
You can also ping our team in the [#website channel on the GraphQL Slack](https://graphql.slack.com/messages/website/). [Get your invite here!](https://graphql-slack.herokuapp.com/)
159157

160-
This repository is managed by EasyCLA. Project participants must sign the free ([GraphQL Specification Membership agreement](https://preview-spec-membership.graphql.org) before making a contribution. You only need to do this one time, and it can be signed by [individual contributors](http://individual-spec-membership.graphql.org/) or their [employers](http://corporate-spec-membership.graphql.org/).
158+
This repository is managed by EasyCLA. Project participants must sign the free [GraphQL Specification Membership agreement](https://preview-spec-membership.graphql.org) before making a contribution. You only need to do this one time, and it can be signed by [individual contributors](https://individual-spec-membership.graphql.org) or their [employers](https://corporate-spec-membership.graphql.org).
161159

162160
To initiate the signature process please open a PR against this repo. The EasyCLA bot will block the merge if we still need a membership agreement from you.
163161

src/code/language-support/python/server/django-graphbox.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -85,10 +85,10 @@ urlpatterns = [
8585

8686
9. Run the server:
8787

88-
```bash
88+
```sh
8989
python manage.py runserver
9090
```
9191

92-
10. Open the GraphiQL interface at `http://localhost:8000/graphql/` and start querying your API!
92+
10. Open the GraphiQL interface at `http://localhost:8000/graphql` and start querying your API!
9393

94-
You can find advanced examples with authentication, filters, validations and more on github or pypi.
94+
You can find advanced examples with authentication, filters, validations and more on GitHub or pypi.

src/code/language-support/python/server/strawberry.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ schema = strawberry.Schema(query=Query)
2626
```
2727

2828
Then run `strawberry server app` and you will have a basic schema server
29-
running on `http://localhost:8000/`.
29+
running on `http://localhost:8000`.
3030

3131
Strawberry also has views for ASGI, Flask and Django and provides utilities
3232
like dataloaders and tracing.

0 commit comments

Comments
 (0)