-
-
Notifications
You must be signed in to change notification settings - Fork 16
Contribution Guidelines for adding content of new conference edition #62
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Hi @benjagm , kindly review this PR at your convenience and suggest some changes/feedbacks if applicable. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work. I just left 2 comments.
Add_NEW_CONFERENCE_EDITION.md
Outdated
Description of the sessions for this edition (For example, Browse through all sessions from the JSON Schema Conference YYYY. Click on a session to view details, watch the presentation, and access related resources.) | ||
``` | ||
|
||
4. Add individual session files in the `content/archive-sessions/YYYY/` directory with the following structure: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we better specity that this content already exists and need to me moved from the sessions folder?
Is not creating content, in reality is moving content.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for pointing that out!
This isn't about creating new content from scratch, but rather moving existing content from the sessions
folder to a new directory. I’ll update the instructions accordingly to better reflect this and make the required changes.
Thank you!
Add_NEW_CONFERENCE_EDITION.md
Outdated
Session description and content. | ||
``` | ||
|
||
## 3. Add Speaker Information |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we specify that is step is moving content from the existing folder. Now seems like creating new content.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @benjagm, this process is meant for adding new speakers whose data isn't already present in the repository.
There are two scenarios:
-
If the speaker already exists
➤ No changes are required. -
If it's a new speaker
➤ The contributor should:- Create a new directory named after the speaker (For example: public/speakers/utkarsh).
- Add an
index.html
file inside that directory. - Copy the structure from an existing speaker’s
index.html
file. - Update the content with the new speaker's details.
I'll make the changes with better clarified step. Let me know if any further changes are needed!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alternatively we can specify this step's heading as :
Add New Speaker Information (if already exists, skip this step)
What's your take on this ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to make it clear that we are 95% moving files, but you haven't used the "move" verb. For example, Add the speakers by moving files from location X to the new location Y.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can make the instructions more easy to follow. We need to make it clear that we are 95% moving files, but you haven't used the "move" verb. For example this type of wording:
Add the speakers by moving files from location X to the new location Y.
Add_NEW_CONFERENCE_EDITION.md
Outdated
Session description and content. | ||
``` | ||
|
||
## 3. Add Speaker Information |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to make it clear that we are 95% moving files, but you haven't used the "move" verb. For example, Add the speakers by moving files from location X to the new location Y.
Hi @benjagm Add New Speaker Information (if the speaker already exists, then skip this step) Additionally, as per your suggestion regarding the use of the word “move,” I’ve revised the relevant steps to more accurately reflect the actions being taken, and ensured the term is only used where actual movement of content occurs. Kindly review the updated changes at your convenience, and please do let me know if there's any further feedback or improvement I should consider. Thank You! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now it looks great. Thanks @Utkarsh-123github
What kind of change does this PR introduce?
Through this PR, we are adding new Contribution guidelines for adding session related content of upcoming future conferences of JSON Schema.
Issue Number:
Summary
By following these guidelines, new contributors can easily add latest conference contents on JSON Schema Conference website.
Does this PR introduce a breaking change?
No.