Skip to content

Commit 2da484f

Browse files
authored
Why use Org GH/HF Generalization (#54)
* Generalize why use orgs on GH and HF names * Add personalization instructions at top with minor generalization
1 parent 924affd commit 2da484f

File tree

3 files changed

+18
-8
lines changed

3 files changed

+18
-8
lines changed

docs/wiki-guide/Why-use-the-Institute-GitHub.md renamed to docs/wiki-guide/Why-use-the-organization-GitHub.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1-
# _"Why should I put my work into the Imageomics GitHub org,"_ you ask?
1+
# _"Why should I put my work into the GitHub org,"_ you ask?
22

3+
<!--
4+
Replace Imageomics GitHub Org links with links to your organization/group GitHub
5+
Replace all instances of "institute" or "Imageomics" with appropriate term or name for your organization or group.
6+
-->
37
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!
48

59
## Centralization
@@ -10,8 +14,8 @@ This is the main aspect that leads to other benefits. Whether you are running yo
1014

1115
- You know where your team's work is, and your team knows where your work is.
1216
- Code is simpler to find, share, access, review, and manage.
13-
- 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.
14-
- Progress can be communicated readily, and help can be solicited when needed, including through [teams](https://github.com/orgs/Imageomics/teams).
17+
- 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.
18+
- 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).
1519

1620
### Knowledge Sharing
1721

@@ -42,4 +46,4 @@ While we encourage you to host your institute-related work on the Imageomics Git
4246
- Personal projects or work not directly tied to the institute.
4347
- Projects developed prior to joining the institute where transferring ownership might be complex or undesirable.
4448

45-
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!
49+
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!

docs/wiki-guide/Why-use-the-Institute-Hugging-Face.md renamed to docs/wiki-guide/Why-use-the-organization-Hugging-Face.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1-
# _"Why should I put my work into the Imageomics Hugging Face org,"_ you ask?
1+
# _"Why should I put my work into the Hugging Face org,"_ you ask?
22

3+
<!--
4+
Replace Imageomics Hugging Face Org links with links to your organization/group Hugging Face
5+
Replace all instances of "institute" or "Imageomics" with appropriate term or name for your organization or group.
6+
-->
37
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:
48

59
## Centralization
@@ -55,4 +59,4 @@ While we encourage you to host your institute-related work on the Imageomics Hug
5559
- Projects developed prior to joining the institute where transferring ownership might be complex or undesirable.
5660

5761

58-
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.
62+
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.

mkdocs.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,12 +108,14 @@ nav:
108108
- "Projects Guide": wiki-guide/Guide-to-GitHub-Projects.md
109109
- "Branch Protections": wiki-guide/When-to-think-about-branch-protections.md
110110
- "Two Repo Problem": wiki-guide/Two-Repo-Problem.md
111-
- "Why Use the Institute GitHub": wiki-guide/Why-use-the-Institute-GitHub.md
111+
# May want to personalize (on page as well): Why use the <organization/group> GitHub
112+
- "Why Use the GitHub Organization": wiki-guide/Why-use-the-GitHub-organization.md
112113
- Hugging Face Guide:
113114
- "Repo Guide": wiki-guide/Hugging-Face-Repo-Guide.md
114115
- "Workflow": wiki-guide/The-Hugging-Face-Workflow.md
115116
- "Dataset Upload Guide": wiki-guide/The-Hugging-Face-Dataset-Upload-Guide.md
116-
- "Why Use the Institute Hugging Face": wiki-guide/Why-use-the-Institute-Hugging-Face.md
117+
# May want to personalize (on page as well): Why use the <organization/group> Hugging Face
118+
- "Why Use the Hugging Face Organization": wiki-guide/Why-use-the-Hugging-Face-organization.md
117119
- FAIR Guide:
118120
- "About FAIR Principles": wiki-guide/FAIR-Guide.md
119121
- "Metadata Checklist": wiki-guide/Metadata-Checklist.md

0 commit comments

Comments
 (0)