From 5fb9d3730f2da60ae79a5893ccd62f5ed7378734 Mon Sep 17 00:00:00 2001 From: egrace479 Date: Tue, 8 Jul 2025 11:19:31 -0400 Subject: [PATCH 1/2] Generalize why use orgs on GH and HF names --- ...stitute-GitHub.md => Why-use-the-organization-GitHub.md} | 0 ...ing-Face.md => Why-use-the-organization-Hugging-Face.md} | 0 mkdocs.yaml | 6 ++++-- 3 files changed, 4 insertions(+), 2 deletions(-) rename docs/wiki-guide/{Why-use-the-Institute-GitHub.md => Why-use-the-organization-GitHub.md} (100%) rename docs/wiki-guide/{Why-use-the-Institute-Hugging-Face.md => Why-use-the-organization-Hugging-Face.md} (100%) diff --git a/docs/wiki-guide/Why-use-the-Institute-GitHub.md b/docs/wiki-guide/Why-use-the-organization-GitHub.md similarity index 100% rename from docs/wiki-guide/Why-use-the-Institute-GitHub.md rename to docs/wiki-guide/Why-use-the-organization-GitHub.md diff --git a/docs/wiki-guide/Why-use-the-Institute-Hugging-Face.md b/docs/wiki-guide/Why-use-the-organization-Hugging-Face.md similarity index 100% rename from docs/wiki-guide/Why-use-the-Institute-Hugging-Face.md rename to docs/wiki-guide/Why-use-the-organization-Hugging-Face.md diff --git a/mkdocs.yaml b/mkdocs.yaml index b346bc5..77101c9 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -108,12 +108,14 @@ nav: - "Projects Guide": wiki-guide/Guide-to-GitHub-Projects.md - "Branch Protections": wiki-guide/When-to-think-about-branch-protections.md - "Two Repo Problem": wiki-guide/Two-Repo-Problem.md - - "Why Use the Institute GitHub": wiki-guide/Why-use-the-Institute-GitHub.md + # May want to personalize (on page as well): Why use the GitHub + - "Why Use the GitHub Organization": wiki-guide/Why-use-the-GitHub-organization.md - Hugging Face Guide: - "Repo Guide": wiki-guide/Hugging-Face-Repo-Guide.md - "Workflow": wiki-guide/The-Hugging-Face-Workflow.md - "Dataset Upload Guide": wiki-guide/The-Hugging-Face-Dataset-Upload-Guide.md - - "Why Use the Institute Hugging Face": wiki-guide/Why-use-the-Institute-Hugging-Face.md + # May want to personalize (on page as well): Why use the Hugging Face + - "Why Use the Hugging Face Organization": wiki-guide/Why-use-the-Hugging-Face-organization.md - FAIR Guide: - "About FAIR Principles": wiki-guide/FAIR-Guide.md - "Metadata Checklist": wiki-guide/Metadata-Checklist.md From a29a0fcaa852a26c44bd1eef9a966facc734eb4f Mon Sep 17 00:00:00 2001 From: egrace479 Date: Tue, 8 Jul 2025 11:32:09 -0400 Subject: [PATCH 2/2] Add personalization instructions at top with minor generalization --- docs/wiki-guide/Why-use-the-organization-GitHub.md | 12 ++++++++---- .../Why-use-the-organization-Hugging-Face.md | 8 ++++++-- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/docs/wiki-guide/Why-use-the-organization-GitHub.md b/docs/wiki-guide/Why-use-the-organization-GitHub.md index 84f02b8..4de1128 100644 --- a/docs/wiki-guide/Why-use-the-organization-GitHub.md +++ b/docs/wiki-guide/Why-use-the-organization-GitHub.md @@ -1,5 +1,9 @@ -# _"Why should I put my work into the Imageomics GitHub org,"_ you ask? +# _"Why should I put my work into the GitHub org,"_ you ask? + The [Imageomics GitHub organization](https://github.com/Imageomics) exists to facilitate collaboration and version control among team members working on projects within the institute and make them available to the research community. You are encouraged to take advantage of the benefits of using this GitHub organization for your institute projects! ## Centralization @@ -10,8 +14,8 @@ This is the main aspect that leads to other benefits. Whether you are running yo - You know where your team's work is, and your team knows where your work is. - Code is simpler to find, share, access, review, and manage. -- Access privileges can be granted and managed through [teams](https://github.com/orgs/Imageomics/teams), which Institute staff can administer for you, rather than access having to be managed on a per-individual basis. -- Progress can be communicated readily, and help can be solicited when needed, including through [teams](https://github.com/orgs/Imageomics/teams). +- Access privileges can be granted and managed through [teams](https://docs.github.com/en/organizations/organizing-members-into-teams/about-teams), rather than access having to be managed on a per-individual basis. +- Progress can be communicated readily, and help can be solicited when needed, including through [teams](https://docs.github.com/en/organizations/organizing-members-into-teams/about-teams). ### Knowledge Sharing @@ -42,4 +46,4 @@ While we encourage you to host your institute-related work on the Imageomics Git - Personal projects or work not directly tied to the institute. - Projects developed prior to joining the institute where transferring ownership might be complex or undesirable. -We strongly encourage you to keep your institute-related work centrally organized in the Imageomics GitHub organization to maximize the benefits for you and your fellow researchers! \ No newline at end of file +We strongly encourage you to keep your institute-related work centrally organized in the [Imageomics GitHub organization](https://github.com/Imageomics) to maximize the benefits for you and your fellow researchers! diff --git a/docs/wiki-guide/Why-use-the-organization-Hugging-Face.md b/docs/wiki-guide/Why-use-the-organization-Hugging-Face.md index 8775ff1..f4c3e15 100644 --- a/docs/wiki-guide/Why-use-the-organization-Hugging-Face.md +++ b/docs/wiki-guide/Why-use-the-organization-Hugging-Face.md @@ -1,5 +1,9 @@ -# _"Why should I put my work into the Imageomics Hugging Face org,"_ you ask? +# _"Why should I put my work into the Hugging Face org,"_ you ask? + The [Imageomics Hugging Face organization](https://huggingface.co/imageomics) is a crucial resource for facilitating collaboration, sharing models, and enhancing the accessibility of our AI and machine learning projects. By utilizing the Imageomics Hugging Face organization, you can take full advantage of the following benefits: ## Centralization @@ -55,4 +59,4 @@ While we encourage you to host your institute-related work on the Imageomics Hug - Projects developed prior to joining the institute where transferring ownership might be complex or undesirable. -We strongly encourage you to leverage the Imageomics Hugging Face organization for your institute-related projects. This will help you and your fellow researchers maximize collaboration, knowledge sharing, and the overall impact of our collective work. +We strongly encourage you to leverage the [Imageomics Hugging Face organization](https://huggingface.co/imageomics) for your institute-related projects. This will help you and your fellow researchers maximize collaboration, knowledge sharing, and the overall impact of our collective work.