-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d5dc970
commit 5b3a65d
Showing
4 changed files
with
37 additions
and
98 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,89 +1,3 @@ | ||
# Instructions for using Template | ||
# Tercen Policy Documents | ||
|
||
## Manual Tasks After Using Template | ||
|
||
Manual changes to be made to the new repository. | ||
|
||
### 1. Create branch on GitHub | ||
|
||
![image](https://github.com/user-attachments/assets/0d436459-20c8-4057-8bdb-9e8b5a28fc35) | ||
|
||
### 2. Create Initial Tag | ||
|
||
Revision structure is based on the related software major revision number. | ||
|
||
e.g . If the document relates to Tercen and Tercen is at revision 0.15.5 then the document is 0.15.x | ||
|
||
The Minor revision is the document revision. | ||
|
||
### 3. Changes to mkdocs.yaml | ||
|
||
Change the following to what is relevant to the new repository. Replace the "administrators_guide" below references. | ||
|
||
``` | ||
site_name: Tercen Administrators Guide | ||
repo_url: https://github.com/tercen/administrators_guide | ||
repo_name: tercen/administrators_guide | ||
repository: tercen/administrators_guide | ||
``` | ||
|
||
## Markdown Examples | ||
|
||
Bolded List | ||
|
||
- **Yellow:** Factor names for id codes and experimental data. | ||
- **Green:** Factor names for measurements. | ||
- **Blue, Beige, Orange:** Individual records with data. | ||
|
||
Quote feature for drag and drop function | ||
|
||
_**From Gather**_ | ||
> Value to Y-Axis. | ||
> Variable to Row. | ||
Table | ||
|
||
| Name | Good looking score | Text | | ||
| --------------------- | ------------------ | ------- | | ||
| Tommy | 7 | | | ||
| Hansel from Zoolander | 933 | | | ||
| You | 10 | ASFSADF | | ||
|
||
## Navigation Table in mkdocs.yaml | ||
|
||
When finished creating the individual Markdown pages to a tutorial they have to me referenced in the mkdocs.yaml file. | ||
|
||
The top level of the hierarchy (Introduction & Tutorial) is displayed in tabs in the MKDocs deployment. | ||
Subsequent indents become the right sidebar navigation of a Tab. | ||
An In-page navigation is generated in the left sidebar from the markdown headings in the document. | ||
|
||
```nav: | ||
- Introduction: index.md | ||
- Tutorial: | ||
- Create a Project: create_a_project.md | ||
- Upload Data: upload_data.md | ||
- Basic Analysis - Workflow: workflow.md | ||
- Using Operators: operators.md | ||
- Join Data files: join.md | ||
- Export a Data Table: export_data.md | ||
- Perform a Gather: gather.md | ||
- Apply a Filter: filter.md | ||
- Collaboration Tips: collaborate.md | ||
``` | ||
|
||
## Local Build Instructions (Linux) | ||
|
||
```shell | ||
docker run --rm -it \ | ||
-p 8000:8000 \ | ||
-v ${PWD}:/docs \ | ||
-e MKDOCS_GIT_COMMITTERS_APIKEY=$GITHUB_TOKEN \ | ||
--entrypoint sh \ | ||
squidfunk/mkdocs-material | ||
|
||
pip install mike | ||
pip install mkdocs-git-committers-plugin-2 | ||
pip install mkdocs-git-revision-date-localized-plugin | ||
|
||
mkdocs serve --dev-addr=0.0.0.0:8000 | ||
``` | ||
<https://tercen.github.io/policy_documents/pre-release/Privacy/> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,32 @@ | ||
@import url('https://fonts.googleapis.com/css?family=Fira+Sans'); | ||
@import url('https://fonts.googleapis.com/css?family=Source+Sans'); | ||
|
||
:root { | ||
--md-primary-fg-color: #006a7f; | ||
--md-primary-fg-color--light: #8bbed1; | ||
--md-primary-fg-color--dark: #1e5051; | ||
} | ||
|
||
p, div { | ||
font-family: 'Source Sans', sans-serif; | ||
} | ||
|
||
h1, h2, h3, li.book-part { | ||
font-family: 'Fira Sans', sans-serif; | ||
font-weight: bold; | ||
} | ||
|
||
p.caption { | ||
color: #777; | ||
margin-top: 10px; | ||
} | ||
p code { | ||
white-space: inherit; | ||
} | ||
pre { | ||
word-break: normal; | ||
word-wrap: normal; | ||
} | ||
pre code { | ||
white-space: inherit; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters