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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 23 commits into
base: main
Choose a base branch
from
Open

Post-collab guide updates #65

wants to merge 23 commits into from

Conversation

egrace479
Copy link
Member

@egrace479 egrace479 commented Aug 22, 2025 •
edited
Loading

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

  • Removes ABC dataset and model card templates (also updates intros and fixes templates to be open).
  • 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.
  • Why use orgs back to Imageomics-specific.
  • 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.
    • Remove template ref at bottom of landing page.
  • 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
@egrace479
Rename to CDSG for template guide (#48)
a7c25b0 
ref #43 'Imageomics-guide' to 'Collaborative-distributed-science-guide' in URLs and descriptions
@egrace479
Small fixes (#51)
f21a768 
* fix typo in ABC French acknowledgement and gh-pages typo
@egrace479 @gwtaylor
Update repo descriptions, attribution, and how to use (#50)
b4e30e2 
* 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]>
@egrace479
Set up as joint code of conduct for shared space (#53)
924affd
@egrace479
Why use Org GH/HF Generalization (#54)
2da484f 
* Generalize why use orgs on GH and HF names

* Add personalization instructions at top with minor generalization
@egrace479 @gwtaylor
Update template site homepage (#52)
a162243 
* 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]>
@gwtaylor
feat(contributing): add comprehensive project standards and guidelines (
90d8144 
#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
@egrace479
Fix pointers to match page names and update nav bar accordingly (#60)
865c820
@egrace479 @hlapp
Add Digital Product Policy tab landing page + life cycle (#59)
09a7668 
* Add landing page introducing digital policies

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

Co-authored-by: Hilmar Lapp <[email protected]>
@egrace479
fix life cycle page formatting (#61)
35851cc
@egrace479
Apply linter to the repo and update rules (#64)
c61bfb8 
* 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
@egrace479
Revert to Imageomics Guide in refs
30a783a 
all headings, references, and hyphenated URLs
@egrace479
Revert site descriptors, nav, logos, and acknowledgement footer
0d9921f
@egrace479
Add preamble suggesting distinction for more general contributions
e60bb84 
points to collab guide template repo for broadly-applicable contributions
@egrace479
Remove template-specific sections, update history
7d5b10b 
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
@egrace479 egrace479 linked an issue Aug 22, 2025 that may be closed by this pull request
Reformulate this Repository as a Base Repo: Collaborative-distributed-science-guide #38
Open
15 tasks
@egrace479
Revert to Imageomics focus
41dd00a 
logos and link to them on GH for download,
overall description, and infrastructure used
@egrace479
Remove Canadian part from ABC funding
1c8a394
@egrace479
Set Collab Guide as reference, adjust authors accordingly
2ecc1e4 
version will go to 2.0.0, date still to be set
@egrace479 egrace479 marked this pull request as ready for review August 26, 2025 17:01
@egrace479
Copy link
Member Author

egrace479 commented Aug 26, 2025 •
edited
Loading

The date of release (in CITATION.cff) will be updated on approval to indicate the correct date, but otherwise this should now be ready. Also note that it will be merged with a merge commit to maintain shared history with the Collab Guide.

Actual changes are as described above; please ensure everything was appropriately changed back to Imageomics-specific. Note that we are keeping the joint grant acknowledgement in the README, but the footer of the site is to contain a reference to the Collab Guide and otherwise be just Imageomics.

@egrace479
Add padding on logo in header to avoid distortion
df04324 
header size setting expects square logo, but can't make logo square
setting proportional sizes makes it look distorted, padding worked best
@egrace479
Copy link
Member Author

Padding at header to resolve logo distortion evident prior to commit df04324:
Screenshot 2025-08-26 at 3 29 47 PM

hlapp
hlapp approved these changes Aug 26, 2025
View reviewed changes
Copy link
Member

@hlapp hlapp left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it looks all good! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hlapp hlapp hlapp approved these changes

@thompsonmj thompsonmj Awaiting requested review from thompsonmj

@NetZissou NetZissou Awaiting requested review from NetZissou

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Reformulate this Repository as a Base Repo: Collaborative-distributed-science-guide
3 participants
@egrace479 @hlapp @gwtaylor