website icon indicating copy to clipboard operation
website copied to clipboard

[📝 Docs]: Blog Post: Announcement of GSOD Documentation Contribution & Progress

Open kwennB opened this issue 1 year ago • 3 comments

What Docs changes are you proposing?

This is an announcement blog post for the community to share the JSON Schema documentation efforts so far.

Here is a table of contents draft.

Proposed title: Feedback during JSON Schema research/ docs audit

Table of Content

Introduction.

  • The vision of the project,
  • The goals of our project, and
  • How the GSoD subproject fits into the overall vision.
  • GSOD contributors and brief on who handles what in the project, although this may be shared in minor detail.

Work completed (May-August)

  • Documentation audit
  • User journey
    • Discovery
    • Evaluation
    • Adoption & Learning
    • Implementation & Validation
    • Troubleshooting
    • Contributing and Advocacy
  • Feedback. (The feedback based on what we’ve covered so far;;)
    • Structure/Format (Section heading)
    • Navigation
    • Most defaulting Pages
    • Website fixes
    • Would also cover the good things the JSON documentation has and the opportunities for improvement.

Future Plans

  • Remaining tasks until project completion
  • Long-term documentation maintenance strategy

How you can contribute

  • Meetings hours
  • Good first issues
  • Work-review

Conclusion

  • Call to Action
  • Invite for community review and contributions
  • How to get started (links to GitHub, communication channels, etc.)

Code of Conduct

  • [X] I agree to follow this project's Code of Conduct

kwennB avatar Jul 22 '24 16:07 kwennB

Thanks for this issue @kwennB . In the feedback part I suggest focussing on the developer journeys (Miro) instead of the specific actions and link the related issue 2 issues for more details.

benjagm avatar Jul 22 '24 21:07 benjagm

IMHO one important call to action is to invite people to join the discussion of the GSoD issues in progress and provide feedback.

benjagm avatar Jul 24 '24 07:07 benjagm

Hi @benjagm, Could you take another look at the outline? It has been updated.

kwennB avatar Jul 29 '24 14:07 kwennB

Hello! :wave:

This issue has been automatically marked as stale due to inactivity :sleeping:

It will be closed in 180 days if no further activity occurs. To keep it active, please add a comment with more details.

There can be many reasons why a specific issue has no activity. The most probable cause is a lack of time, not a lack of interest.

Let us figure out together how to push this issue forward. Connect with us through our slack channel : https://json-schema.org/slack

Thank you for your patience :heart:

github-actions[bot] avatar Mar 16 '25 02:03 github-actions[bot]