Skip to content

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

Merged
merged 2 commits into from
Jun 27, 2025

Conversation

Utkarsh-123github
Copy link
Member

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.

@Utkarsh-123github
Copy link
Member Author

Hi @benjagm , kindly review this PR at your convenience and suggest some changes/feedbacks if applicable.
Thank You 🚀

Copy link
Contributor

@benjagm benjagm left a 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.

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:
Copy link
Contributor

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.

Copy link
Member Author

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!

Session description and content.
```

## 3. Add Speaker Information
Copy link
Contributor

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.

Copy link
Member Author

@Utkarsh-123github Utkarsh-123github Jun 14, 2025

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:

    1. Create a new directory named after the speaker (For example: public/speakers/utkarsh).
    2. Add an index.html file inside that directory.
    3. Copy the structure from an existing speaker’s index.html file.
    4. 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!

Copy link
Member Author

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 ?

Copy link
Contributor

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.

Copy link
Contributor

@benjagm benjagm left a 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.

Session description and content.
```

## 3. Add Speaker Information
Copy link
Contributor

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.

@Utkarsh-123github
Copy link
Member Author

Hi @benjagm
I've updated the guidelines based on our discussion. There was a slight confusion regarding the speaker addition step, just to clarify, we aren't actually moving anything in this case. That step is meant to handle the scenario where a new speaker isn’t yet present in our codebase and needs to be added. To make this clearer, I’ve updated the heading to:

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!

Copy link
Contributor

@benjagm benjagm left a 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

@benjagm benjagm merged commit 6941894 into json-schema-org:main Jun 27, 2025
@Utkarsh-123github Utkarsh-123github deleted the doc-addition branch June 27, 2025 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

✨ Add Contribution Guidelines for adding new conference edition entries in future
2 participants