Skip to content
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

T7c3: Contribution guide for content writers. #686

Open
PhilReedData opened this issue Feb 3, 2025 · 0 comments
Open

T7c3: Contribution guide for content writers. #686

PhilReedData opened this issue Feb 3, 2025 · 0 comments
Labels
Hack Cologne 2025 Bioschemas hackathon February 2025 in Cologne prio: high

Comments

@PhilReedData
Copy link
Contributor

PhilReedData commented Feb 3, 2025

  • UX/UI new content (b website)
  • Documentation
  • Must-have
  • Difficulty medium

Part of Task 6

Excerpt from report: Task 6: Governance for contributions

There exists governance documentation for community contributions to profiles and types. However, it does not cover contributions to guidelines and documentation, which may be written by a wider set of personas, including those with less technical experience or expertise. Task 6 seeks to fill this gap, proposing additional governance for guidelines and documentation contributions. This task was deprioritised and will be revisited when possible. This would describe how users can contribute to missing guidance, help in its review, and would include for example the provision of templates to facilitate submissions.

Currently, there are two ways of contributing. Contributors can either submit their work via Google Docs or directly through GitHub, with the latter being the preferred option for the convenience of the editors.

It is crucial to determine who will handle the review process, ensuring the materials align with our guidelines, serve the intended purpose, and are thoroughly tested.
Any recommendations will need to be formally presented to the Bioschemas steering group for approval.

We need to clarify our objectives and provide contributors with general guidance on suitable content for submission. We might consider developing one or more templates to support this, which can then be presented to the committee. Templates may vary based on the type of contribution—examples include summaries, step-by-step guides, and overviews.

Current priorities:

  1. Our primary focus is on creating a step-by-step guide for implementing Bioschemas with content management systems (CMS). At this stage, we have one approach documented on GitHub using Jekyll.
  2. Introducing Bioschemas: For non-technical contributors, we should provide a general introduction to Bioschemas, including an overview of metadata and some descriptive guidance that doesn’t require coding.
@PhilReedData PhilReedData added Hack Cologne 2025 Bioschemas hackathon February 2025 in Cologne prio: high labels Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Hack Cologne 2025 Bioschemas hackathon February 2025 in Cologne prio: high
Projects
None yet
Development

No branches or pull requests

1 participant