Skip to content

Post-collab guide updates #65

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

Draft
wants to merge 15 commits into
base: main
Choose a base branch
from
Draft

Post-collab guide updates #65

wants to merge 15 commits into from

Conversation

egrace479
Copy link
Member

@egrace479 egrace479 commented Aug 22, 2025

This PR reverts most of the Collab Guide template repo back to the Imageomics Guide:

  • Removes ABC dataset and model card templates.
  • Adjusts the acknowledgment footer to indicate co-development, but Imageomics funding.
  • Reverts to just Imageomics logo.
  • All refs, nav, etc. back to Imageomics Guide.
  • Code of Conduct just Imageomics.
  • Homepage back to just Imageomics (infrastructure, logos, description).

It also has some updates including

  • the introduction of CONTRIBUTING.md (the preamble at lines 3-7 has been updated for Imageomics).
  • repo linting (to match contributing guidelines)
  • an update to the Digital Product Policy tab (see template) to include a landing page and the Digital Product Lifecycle.
  • An update to the CITATION.cff to include the Collab Guide as a reference and increment the version to 2.0.0.
  • Updated Collaborative Infrastructure diagram.

egrace479 and others added 15 commits June 9, 2025 10:18
ref #43 'Imageomics-guide' to 'Collaborative-distributed-science-guide' in URLs and descriptions
* fix typo in ABC French acknowledgement and gh-pages typo
* Use shared logo, adjust size for visibility

* Update citation to include all contributors

* Add comments for personalizing & attribution, how to use the template guide

* Add 'History' subsection to further contextualize the guide
particularly, includes mention of ABC
---------

Co-authored-by: Graham Taylor <[email protected]>
* Generalize why use orgs on GH and HF names

* Add personalization instructions at top with minor generalization
* Ref #49: redesign collab infrastructure diagram & rename

* Add joint components to template site homepage

* intro linking to 'About this Guide' for more context and personalization instructions

* shared logo
---------

Co-authored-by: Graham Taylor <[email protected]>
#56)

- Add CONTRIBUTING.md with markdown formatting requirements
- Document license format specifications for Hugging Face compatibility
- Include development workflow and testing procedures
- Adopt conventional commits standard with project examples
- Add quality assurance guidelines and platform-specific requirements

Resolves #55
* Add landing page introducing digital policies

* Add product/project life cycle and diagram 
---------

Co-authored-by: Hilmar Lapp <[email protected]>
* Update linting rules

ignores template pages--these shouldn't be edited and were designed for ease-of-use
ignores mkdocs.yaml
avoid rules that don't work in some locations (e.g., need HTML for table formatting)
allow '!' in header

* Update information on linting
Add new settings and linting instructions
Add note that local linting is optional
all headings, references, and hyphenated URLs
points to collab guide template repo for broadly-applicable contributions
explains joint acknowledgement and points to template for those wishing to produce their own version
@egrace479 egrace479 added design UX or presentation needs attention documentation Improvements or additions to documentation enhancement New feature or request structure Refactoring or architecture, general code organization labels Aug 22, 2025
@egrace479 egrace479 modified the milestone: Generalize Guide Aug 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design UX or presentation needs attention documentation Improvements or additions to documentation enhancement New feature or request structure Refactoring or architecture, general code organization
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reformulate this Repository as a Base Repo: Collaborative-distributed-science-guide
2 participants