You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING-docs.md
+16Lines changed: 16 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,6 +64,22 @@ After you have been assigned to an issue, fork the [json-schema-org/website](htt
64
64
65
65
To propose modifications to our documentation that do not have an issue in the [documentation board](https://github.com/orgs/json-schema-org/projects/16), you can [create a GitHub issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue#creating-an-issue-from-a-repository) and use the *Documentation* template to describe the changes. After that, you can decide whether you want to work on the changes yourself or let someone else claim the issue. If you decide to work on the issue, assign it to yourself and commit the changes to a new branch.
66
66
67
+
## Add metadata to newly created markdown files
68
+
Metadata helps organize content and maintain consistency across all pages in the documentation. It also provides key information about the file, such as its title, author, and the last updated date.
69
+
70
+
When contributing to the documentation, it is essential to include metadata in every new markdown file. Metadata is critical for successfully building and rendering the file locally. Without it, the file may fail to render correctly or cause errors in the documentation system.
71
+
72
+
### Example of metadata in a new markdown file
73
+
Every new `.md` file should start with a YAML front matter block. Here's an example:
74
+
---
75
+
title: "Your Page Title"
76
+
section: "docs" # Can be used to categorize the content
77
+
date: "YYYY-MM-DD" # Optional: Date when the page was created or last updated
78
+
author: "Your Name" # Optional: Your name if you're the author
79
+
tags: ["tag1", "tag2"] # Optional: Tags to categorize the page
80
+
---
81
+
To add the front matter metadata, copy and paste the example above at the top of your .md file and replace the details with the information of your document.
82
+
67
83
## Create a Pull Request
68
84
69
85
To submit your work to review by the community, open a draft pull request to the `main` upstream branch, and add the issue your pull request solves. Add @json-schema-org/docs-team as a reviewer of your pull request, and let us know in the #documentation Slack channel your pull request is ready for review.
Copy file name to clipboardExpand all lines: README.md
+28-26Lines changed: 28 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,15 +20,15 @@
20
20
</p>
21
21
22
22
# 👋 Welcome to the JSON Schema website
23
-
This repository contains the sources of JSON Schema website:
23
+
This repository contains the source code of the JSON Schema website:
24
24
25
-
*It's powered by Next.js,
26
-
*It uses Tailwind CSS framework,
27
-
*It's build and deployed with Netlify.
25
+
*Powered by Next.js,
26
+
*Uses the Tailwind CSS framework,
27
+
*Built and deployed with Netlify.
28
28
29
-
## Setting up Project
29
+
## Setting up the Project
30
30
31
-
Please refer to the [INSTALLATION.md](./INSTALLATION.md)file for instructions on how to set up the project on your local machine.
31
+
Please refer to [INSTALLATION.md](./INSTALLATION.md) for instructions on how to set up the project for local development.
32
32
33
33
## Project structure
34
34
@@ -37,41 +37,42 @@ This repository has the following structure:
37
37
<!-- If you make any changes in the project structure, remember to update it. -->
38
38
39
39
```text
40
-
├── .github # Definitions of GitHub workflows, pull request and issue templates
40
+
├── .github # Definitions of GitHub workflows, pull request, and issue templates
41
41
├── components # Various generic components such as "Button", "Figure", etc.
42
-
├── data # JSON Schema Implementations.
42
+
├── data # JSON Schema implementations
43
43
├── styles # Various CSS files
44
-
├── lib # Various JS code for preparing static data to render in pages
45
-
├── pages # Website's pages source. It includes raw markdown files and React page templates.
44
+
├── lib # Various JS code for preparing static data to render on pages
45
+
├── pages # Website's pages source, including raw markdown files and React page templates
46
46
│ ├── overview # JSON Schema initiative docs
47
47
│ ├── blog # Blog posts
48
48
│ ├── learn # JSON Schema docs
49
49
│ └── implementations # Various pages to describe tools
50
-
├── public # Data for site metadata and static blog such as images
50
+
├── public # Data for site metadata and static assets such as images
51
51
├── next.config.js # Next.js configuration file
52
52
53
53
```
54
54
55
55
## Contribute
56
-
57
56
Here are some areas where you can contribute to the website:
58
-
- Blogs posts
59
-
- Case Studies
57
+
58
+
- Blog posts
59
+
- Case studies
60
60
- Design
61
-
- Documentation
61
+
- Documentation improvements
62
62
- Website enhancements
63
-
- Add a new JSON Schema Implementation
63
+
- Add a new JSON Schema implementation
64
64
- JSON Schema Landscape
65
65
66
-
To figure out a good first issue to work on, join our Slack workspace and visit the `#contribute` channel. This channel is specifically designed for onboarding and supporting new contributors.
66
+
To identify good first issues to work on, join our Slack workspace and visit the `#contribute` channel. This channel is specifically designed for onboarding and supporting new contributors.
67
67
68
68
You should also check out our [Contributing guidelines](./CONTRIBUTING.md).
69
69
70
70
### Contributors
71
71
72
-
Thanks goes to these wonderful people who contributed to this website:
0 commit comments