Skip to content

Commit 42d3ba7

Browse files
authored
Update quickstart.md for ojobpub.json instructions
Clarified the explanation of ojobpub.json and its validation process. Added information about the development of an open-source tool for creating ojobpub.json.
1 parent a8f2acd commit 42d3ba7

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

docs/implementation/quickstart.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,13 @@ You need **your own domain and website**: e.g. www.example.com.
88
There you publish your job openings as web page. This can be using a CMS, static site generator or plain HTML, as you like.
99

1010
## 2. Create ojobpub.json
11-
Create an [ojobpub.json](./ojobpub-format.md) in the path `/.well-known/ojobpub.json` (all lower case!) in a **specific JSON format containing structured meta information** about your job openings and link to the full job description on your website.
11+
Create an [ojobpub.json](./ojobpub-format.md) in the path `/.well-known/ojobpub.json` (all lower case!) in a **specific JSON format containing structured meta information** about your job openings and link to the full job description on your website.
1212

1313
!!! tip "File or Application?"
14-
While we have used a static ojobpub.json file to demonstrate the simplest way to provide the data, this endpoint is not limited to a static file. It could just as easily be served by a dynamic application or script.
14+
While we have used a static ojobpub.json file to demonstrate the simplest way to provide the data, this endpoint is not limited to a static file. It could just as easily be served by a dynamic application or script. An open source tool to help creating a ojobpub.json is currently in development.
1515

1616
## 3. Validate
17-
18-
To validate the JSON data format, we provide a [LetsEmploy's oJobPub JSON schema](https://github.com/letsemploy/schema) and a validator app [validator.letsemploy.org](https://validator.letsemploy.org) to help validate the structure.
17+
To ensure your ojobpub.json's data is valid, we provide a [oJobPub JSON schema](https://github.com/letsemploy/schema) and a validator app [validator.letsemploy.org](https://validator.letsemploy.org).
1918

2019
## 4. Let us know
2120

@@ -25,7 +24,7 @@ This helps us to see, how things are growing. Once this format is known and etab
2524

2625
## 5. Spread the Word
2726

28-
Let others know you are publishing job openings using oJobPub by **adding a link** on your job site:
27+
We would appreciate if you let others know, you publish your job openings using oJobPub by **adding a link** on your job site:
2928

3029
[![Supports LetsEmploy.org](https://img.shields.io/badge/supports-LetsEmploy.org-purple)](https://letsemploy.org){:target="_blank"}
3130

0 commit comments

Comments
 (0)