Skip to content

Commit a162243

Browse files
egrace479gwtaylor
andauthored
Update template site homepage (#52)
* 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]>
1 parent 2da484f commit a162243

File tree

5 files changed

+20
-19
lines changed

5 files changed

+20
-19
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,6 @@
44
# Additional
55
__pycache__
66

7+
# MkDocs build output
8+
site/
9+

.markdownlint.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"MD007": { "indent": 4 },
33
"no-hard-tabs": false,
4-
"MD013": false
4+
"MD013": false,
5+
"MD026": { "punctuation": ".,;:!" }
56
}

docs/index.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,33 @@
11
# Welcome to the Collaborative Distributed Science Guide!
22

3-
This website hosts guides to Imageomics workflows, documentation, and general best-practices for collaborative science. We aim to provide a helpful resource for a broad base of scientists working in the field of [_imageomics_](wiki-guide/Glossary-for-Imageomics.md/#imageomics) and beyond.
3+
This website hosts guides to FAIR (findable, accessible, interoperable, reusable) and reproducible workflows, documentation, and general best-practices for collaborative science. We aim to provide a helpful resource for scientists working in [_imageomics_](wiki-guide/Glossary-for-Imageomics.md/#imageomics) and related interdisciplinary fields.
44

5-
It houses the information needed to get started with and use institute resources readily available to all members. However, most of this guide is applicable to anyone working more broadly in the field of imageomics or adjacent fields of computer and data science, and it is tailored to help domain scientists bridging that gap.
5+
For information about customizing this guide template, see [About the Guide](https://github.com/Imageomics/Collaborative-distributed-science-guide?tab=readme-ov-file#about-the-guide).
66

77
## Highlights
88

9-
There are many pages of useful information contained in this guide covering a range of topics from project management and workflows, to repositories and archives, to a glossary of _imageomics-related_ terms for improved interdisciplinary communication.
9+
There are many pages of useful information contained in this guide covering a range of topics from project management and workflows, to repositories and archives, to a glossary of scientific terms for improved interdisciplinary communication.
1010

1111
### Just starting a project?
12+
1213
Check out our guides to get your project off on the right foot!
1314

14-
- [The GitHub Repo Guide](wiki-guide/GitHub-Repo-Guide.md): This page reviews expected and suggested GitHub repository contents, as well as structural considerations.
15+
- [The GitHub Repo Guide](wiki-guide/GitHub-Repo-Guide.md): This page reviews expected and suggested GitHub repository contents, as well as structural considerations.
1516

1617
- [The Hugging Face Repo Guide](wiki-guide/Hugging-Face-Repo-Guide.md): Analogous expected and suggested repository contents for Hugging Face repositories; there are notable differences from GitHub in both content and structure.
1718

1819
- [FAIR Guide](wiki-guide/FAIR-Guide.md): Guide to producing FAIR digital products, from metadata collection through product documentation and publication. This builds on the content in both the GitHub and Hugging Face Repository Guides, providing checklists to ensure [code](wiki-guide/Code-Checklist.md), [data](wiki-guide/Data-Checklist.md), and [model](wiki-guide/Model-Checklist.md) repositories are FAIR. The latter two closely follow our [HF Templates](wiki-guide/About-Templates.md).
1920

2021
### Project repo up, what's next?
22+
2123
Check out our workflow guides for how to interact with your new repo:
2224

2325
- [The GitHub Workflow](wiki-guide/The-GitHub-Workflow.md): This page mainly focuses on branching and the PR process.
2426

2527
- [The Hugging Face Workflow](wiki-guide/The-Hugging-Face-Workflow.md): Analogous workflow directions for Hugging Face; there are notable differences from GitHub in how this process works practically, though the concept is the same.
2628

2729
### Project management or organization got you down?
30+
2831
Discover new tools to help:
2932

3033
- [Guide to GitHub Projects](wiki-guide/Guide-to-GitHub-Projects.md): This page focuses on GitHub's project management tool, Projects, which integrates issues and pull requests into a unified task board to keep tabs on how your project is progressing. Labels, milestones, and assignee tags provide improved organization, and allow for more focused views.
@@ -33,39 +36,33 @@ Discover new tools to help:
3336

3437
- [Virtual Environments](wiki-guide/Virtual-Environments.md): Summary of `conda` and `pip` environments: how to make, use, and share them.
3538

36-
37-
## Collaborative Infrastructure We Use
39+
## Collaborative Infrastructure used by Imageomics and ABC
3840

3941
- GitHub
40-
- [Institute Code Repositories](https://github.com/Imageomics) where we store our code (software + tools).
42+
- [Imageomics](https://github.com/Imageomics) and [ABC](https://github.com/ABC-Center) Code Repositories, where we store our code (software + tools).
4143
- GitHub's [Docs](https://docs.github.com/en)
4244
- [Repositories](https://docs.github.com/en/repositories)
4345
- [GitHub Projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects)
4446
- Hugging Face
45-
- [Imageomics Organization page](https://huggingface.co/imageomics) where we store our datasets and models (and their metadata).
47+
- [Imageomics](https://huggingface.co/imageomics) and [ABC](https://hf.co/ABC-Center) Organization Pages, where we store our datasets and models (and their metadata).
4648
- Additionally, use [Hugging Face Spaces](https://huggingface.co/docs/hub/spaces) to run demos of models and other projects.
4749
- Hugging Face's [Docs](https://huggingface.co/docs)
4850
- [Model Hub](https://huggingface.co/docs/hub/models-the-hub)
4951
- [Datasets](https://huggingface.co/docs/hub/datasets-overview)
5052

5153
### Collaborative Infrastructure Diagram
52-
![tech_infrastructure_diagram](wiki-guide/images/index/382108831-1173cd79-db94-4326-8b6e-dcbdeb8939cd.png)
5354

55+
![tech_infrastructure_diagram](wiki-guide/images/index/collaborative-infrastructure-diagram.png)
5456

55-
## Imageomics Branding (Logos)
57+
## `<Organization>` Branding (Logos)
5658

57-
We have two versions of the logo, a [fish](logos/Imageomics_logo_fish.png) and a [butterfly](logos/Imageomics_logo_butterfly.png), which should be used for scientific posters, conference, workshop, and meeting marketing materials, etc. Choice of logo is based on user preference.
58-
59-
![butterfly logo](logos/Imageomics_logo_butterfly.png){: style="width:45%"}
60-
![fish logo](logos/Imageomics_logo_fish.png){: style="width:45%"}
59+
Since this is a joint Imageomics and ABC project, we have a special combined logo:
6160

61+
![combined Imageomics and ABC logo](logos/Imageomics_ABC.png){: style="width:75%"}
6262

6363
## Other pages of note
64+
6465
- [Glossary for Imageomics](wiki-guide/Glossary-for-Imageomics.md): Collection of terms used in imageomics. The goal is to ensure all participating domains are represented, thus facilitating interdisciplinary communication. This is a group effort, please check it out and add terms you think should be there!
6566
- [Command Line Cheat Sheet](wiki-guide/Command-Line-Cheat-Sheet.md): Collection of useful bash and git commands with some git tips.
6667

67-
68-
<br>
69-
<br>
70-
7168
!!! question "[Questions, Comments, or Concerns?](https://github.com/Imageomics/Collaborative-distributed-science-guide/issues)"
Binary file not shown.
71.4 KB
Loading

0 commit comments

Comments
 (0)