Skip to content
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

Updated category documentation #182

Merged
merged 4 commits into from
Jul 12, 2019
Merged

Updated category documentation #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ff966f9
category documentation
hauten Jul 9, 2019
2661dcd
Merge remote-tracking branch 'origin/master' into category-documentation
hauten Jul 9, 2019
2c65c34
Updated two files per @gonsie recommendations
hauten Jul 11, 2019
9168dcd
revised Applications blurb
hauten Jul 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions assets/images/logos/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@

The home and /radiuss pages display a logo next to each repo when they appear under the topica categories. This feature does not apply to the /catalog view.

If a repo has its own logo, that should display. If not, then its organization's avatar should display. Every repo should have one logo or avatar; no repo should be "empty."
If a repo has its own logo, that should display. If not, then its organization's avatar should display. Every repo should have one logo or avatar; no repo should be "empty." Organization avatars are pulled from GitHub.

Logo files should be uploaded to a specific protected OneDrive folder called [Repo logos (all) - standard file names](https://doellnl-my.sharepoint.com/personal/auten1_llnl_gov/_layouts/15/onedrive.aspx?id=%2Fpersonal%2Fauten1%5Fllnl%5Fgov%2FDocuments%2FOS%20portal%20%28software%2Ellnl%2Egov%29%20design%20mockups%2FRepo%20logos%20%28all%29%20%2D%20standard%20file%20names).
- Each file should contain the repo name plus `repo-logo` separated by hyphens (e.g., `MFEM-repo-logo`).
- Files should be .jpg, .gif, or .png.
- Contact @hauten if you are unable to access.
Repo logo files should follow a naming convention and be added to the directory. All files must be in .png format.
- Repository logo: `<repo_name>.png`
- Directory: `/assets/images/logos/<org name>`
11 changes: 6 additions & 5 deletions categories/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,21 @@

This folder is the home of the JSON file containing the info for the categories that are displayed on the website's home page. If any edits need to be made to these categories, just edit the data in the JSON and the home page will reflect your changes automatically.

A repository can have up to 20 tags. Te list below also contains each category's blurb to ensure consistency in phrasing and length. Note that in some cases the category is plural but the corresponding tag is singular.
A repository can have up to 20 tags. The list below also contains each category's blurb to ensure consistency in phrasing and length. Note that in some cases the category is plural but the corresponding tag is singular.

For each category this file contains it's title, [icon][icon dir] filepath, and category description.

This data is read by the [category info javascript][js dir].
For each category this file contains it's title, [icon][icon dir] filepath, and category description. This data is read by the [category info javascript][js dir].

[icon dir]: ../assets/images/
[js dir]: ../js/category-info.js

- Applications: Advance science with modeling and simulation codes - `application`
- Applications: Browse scientific simulation codes and IT management tools - `application`
- Build Tools: Automate and simplify complex dependencies and deployments - `build-tools`
- Complete Catalog: Browse all LLNL open source projects - no tags required
- Data Management & Viz: Manage visualizations with robust features and configurable analysis - `data-management`, `data-viz`
- Math & Physics Libraries: Optimize solvers, higher order methods, and AMR frameworks - `math-physics`
- Performance & Workflow: Manage and scale complex workflows, tracking, and data collection - `performance`, `workflows`
- Portable Execution & Memory Mgmt: Automate data motion and memory allocation on advanced architectures - `memory-management`, `portability`
- Proxy Applications: Prepare for testing and porting applications - `proxy-application`
- System Software: Manage clusters and parallel environments - `system-software`

In general, topic tags raise a repo's visibility on GitHub and help users find related projects. The following tags, which are are not associated with the home page categories above, are recommended for LLNL repos: `amr` (adaptive mesh refinement), `checkpoint`, `cmake`, `cpp` (C++), `energy`, `exascale-computing`, `finite-elements`, `fortran`, `gpu`, `hpc`, `javascript`, `machine-learning`, `matlab`, `monte-carlo`, `mpi`, `neural-network`, `parallel`, `python`, `shell`, `simulation`, `solver`, `uncertainty-quantification`.