diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..68806b117c23e5ce3d321bc3a94e29a6754262da --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +*.idea +.vscode \ No newline at end of file diff --git a/README.md b/README.md index 376dadfa3ec40ace1189d87481ed2481f75d16e7..8ec41206c7959d2094ad374900967f2d765d5bfb 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,13 @@ Merge requests are welcome if you have suggestions for improving the documentati IICS is part of the infrastructure and services being delivered by the [Interoperability Initiative](https://interop.it.wisc.edu/). -## Contents +## Adding New Content +Use [template.md](./template.md) to create new content. -- [Training](./training.md) \ No newline at end of file +## Contents +* [Quick Start Guide](./docs/quickstart.md) +* [Benefits](./docs/benefits.md) +* [Onboarding into IICS](./docs/onboarding.md) +* [Concepts](./docs/concepts.md) +* [Tutorials](./docs/tutorials.md) +* [Training](./docs/training.md) diff --git a/docs/benefits.md b/docs/benefits.md new file mode 100644 index 0000000000000000000000000000000000000000..2cc013d1e24962c7e48129ede49a4790ac82472c --- /dev/null +++ b/docs/benefits.md @@ -0,0 +1,5 @@ +# Benefits of Using IICS + +### TODO +* [ ] Incorporate changes in this [draft](https://docs.google.com/document/d/1k96ihbR0UpicfcRKFyFcJmII92mRavVFAeUq8CPGBqo/edit?disco=AAAAGY041Sc&ts=5e90aa6e&usp_dm=false). +* [ ] Include a diagram to explain benefits visually - https://jira.doit.wisc.edu/jira/browse/INPLATFORM-87. \ No newline at end of file diff --git a/docs/concepts.md b/docs/concepts.md new file mode 100644 index 0000000000000000000000000000000000000000..7a10c6521465fe51233298a6298e09a86c16fd86 --- /dev/null +++ b/docs/concepts.md @@ -0,0 +1,8 @@ +# IICS Concepts + +### TODO +* [ ] Add TOC. +* [ ] Add common IICS concepts, few examples are below. + +* Secure Agent +* Different Type of Integrations \ No newline at end of file diff --git a/docs/images/.gitkeep b/docs/images/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/docs/onboarding.md b/docs/onboarding.md new file mode 100644 index 0000000000000000000000000000000000000000..2940345bb7f1800b66fe76993cdce8acea9fed6f --- /dev/null +++ b/docs/onboarding.md @@ -0,0 +1,4 @@ +# Onboarding into IICS + +### TODO +* [ ] Add content for provisioning [docs](https://git.doit.wisc.edu/interop/iics/internal-iics-docs/merge_requests/1). \ No newline at end of file diff --git a/docs/quickstart.md b/docs/quickstart.md new file mode 100644 index 0000000000000000000000000000000000000000..4a8074646157243091b631514e474af747ffde2c --- /dev/null +++ b/docs/quickstart.md @@ -0,0 +1,5 @@ +# Quick Start Guide +Step by step guide for quick start with IICS. + +### TODO +*[ ] Write quick start guide - https://jira.doit.wisc.edu/jira/browse/INPLATFORM-69. \ No newline at end of file diff --git a/training.md b/docs/training.md similarity index 100% rename from training.md rename to docs/training.md diff --git a/docs/tutorials.md b/docs/tutorials.md new file mode 100644 index 0000000000000000000000000000000000000000..ab49cd2d46b4e319595a4e4041a493c808bd8018 --- /dev/null +++ b/docs/tutorials.md @@ -0,0 +1,4 @@ +# Tutorials +Various integrations developed using IICS. + +* [WiscAlerts Integrations](./tutorials/wiscalerts.md) diff --git a/docs/tutorials/wiscalerts.md b/docs/tutorials/wiscalerts.md new file mode 100644 index 0000000000000000000000000000000000000000..a438c5907e9f6013f03eaa23c6aa7f88a438c489 --- /dev/null +++ b/docs/tutorials/wiscalerts.md @@ -0,0 +1,2 @@ +### TODO +* [ ] Add content - https://jira.doit.wisc.edu/jira/browse/INPLATFORM-96 \ No newline at end of file diff --git a/template.md b/template.md new file mode 100644 index 0000000000000000000000000000000000000000..5190704210c7b392c9e2a5e9bb52a822f43df7d1 --- /dev/null +++ b/template.md @@ -0,0 +1,23 @@ +Include a table of content in each document for easy navigation. + +## Table Of Contents +* [Heading 1](#heading-1) +* [Heading 2](#heading-2) + * [Sub Heading 1](#sub-heading-1) + * [Sub Heading 2](#sub-heading-2) +* [Heading 3](#heading-3) + +# Heading 1 +[heading1]: #heading-1 + +## Sub Heading 1 +[sub-heading1]: #sub-heading-1 + +## Sub Heading 2 +[sub-heading2]: #sub-heading-2 + +# Heading 2 +[heading2]: #heading-2 + +# Heading 3 +[heading3]: #heading-3 \ No newline at end of file