Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
wolfiex committed Oct 2, 2024
1 parent 85e3fc3 commit f62b750
Show file tree
Hide file tree
Showing 24 changed files with 56 additions and 956 deletions.
2 changes: 1 addition & 1 deletion CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
wiki.mipcvs.dev
drdocs.mipcvs.dev
31 changes: 3 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,19 @@
# mipcvs-wiki
# Data Request Documentation (Live)

[![MkDocs Build + Deploy](https://github.com/WCRP-CMIP/mipcvs-wiki/actions/workflows/deploy.yml/badge.svg?branch=main)](https://github.com/WCRP-CMIP/mipcvs-wiki/actions/workflows/deploy.yml) [![Deploy static content to Pages](https://github.com/WCRP-CMIP/mipcvs-wiki/actions/workflows/staticpublish.yml/badge.svg)](https://github.com/WCRP-CMIP/mipcvs-wiki/actions/workflows/staticpublish.yml)


Contents for the MIPCVs wiki. See [wiki.mipcvs.dev](https://wiki.mipcvs.dev/)
To View See [drdocs.mipcvs.dev](https://drdocs.mipcvs.dev/)

---

## What?
This repository updates the wiki for CV updates. It contains infomration that will be used to inform the submission process and caviats in relation to this. The intuitive markdown format and open source (github repo) format allow relevant leads and users to update the documentation in real time.

The files within here consist of a nested structure on markdown files, that may be downloaded and distributed with the software. These can be found within the `docs` folder. T

A secondary technical wiki outlining how to change the intircasies of mkdoc and other tools will be available at developer.mipcvs.dev.


---

## Editing the documentation.
Docmentation is found in the `docs` folder with the file names and hierarchy affecting the navigational menu.

### Editing materials.

- menu/page name is determined by the `#` header tag at the top of a file.


Expand All @@ -30,25 +22,8 @@ A secondary technical wiki outlining how to change the intircasies of mkdoc and
https://github.com/selfhostedshow/wiki/tree/master
### Permissable items
https://squidfunk.github.io/mkdocs-material/reference/admonitions/




## developer notes
### developer notes
The following are Notes and will be tidied away in due course.

https://squidfunk.github.io/mkdocs-material/getting-started/



### install
`docker pull squidfunk/mkdocs-material`

### creating a site. Dont run.
`docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material new .`

### preview
`docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`

### build
`docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build`
Binary file modified docs/.DS_Store
Binary file not shown.
86 changes: 0 additions & 86 deletions docs/99_Acknowlegements.md

This file was deleted.

Binary file removed docs/CMIP6Plus/.DS_Store
Binary file not shown.
Binary file removed docs/CMIP6Plus/Automations/.DS_Store
Binary file not shown.
137 changes: 0 additions & 137 deletions docs/CMIP6Plus/Automations/creating_a_dispatch_automation.md

This file was deleted.

80 changes: 0 additions & 80 deletions docs/CMIP6Plus/Automations/gencv_action.md

This file was deleted.

Loading

0 comments on commit f62b750

Please sign in to comment.