diff options
| author |   Bruno Sakoto <bruno.sakoto@bell.ca> | 2021-09-27 19:26:28 -0400 |
|---|---|---|
| committer | Bruno Sakoto <bruno.sakoto@bell.ca> | 2021-09-28 11:15:28 -0400 |
| commit | 394e1c720d4af88195d1f905c520c98b5e4e9270 (patch) | |
| tree | 81d35f9159d0623cc6095c0db08785c7e6152be2 | |
| parent | 8d443ef01e1c85773a9c82910443199de85f24ab (diff) | |
Review index documentation
* Add admin guide
* Move apis to design
* Add master index as required by main doc project
Issue-ID: CPS-447
Signed-off-by: Bruno Sakoto <bruno.sakoto@bell.ca>
Change-Id: I6dbb562a8b4505768b5689f90375df6bb30803da
| -rw-r--r-- | docs/content/admin-guide.rst (renamed from docs/content/apis.rst) | 17 | ||||
| -rw-r--r-- | docs/content/design.rst | 9 | ||||
| -rw-r--r-- | docs/index.rst | 6 |
3 files changed, 18 insertions, 14 deletions
diff --git a/docs/content/apis.rst b/docs/content/admin-guide.rst index c483ea1..0f52d30 100644 --- a/docs/content/apis.rst +++ b/docs/content/admin-guide.rst @@ -4,17 +4,12 @@ .. .. Copyright (C) 2021 Bell Canada -========================= -CPS Temporal Exposed APIs -========================= +======================== +CPS Temporal Admin Guide +======================== .. warning:: Draft -* REST API - - * Specification - * Postman Collection - -* Event Schema - - * Json Schema +* Link to deployment configuration +* Logging +* ... diff --git a/docs/content/design.rst b/docs/content/design.rst index 167d93d..7a6590d 100644 --- a/docs/content/design.rst +++ b/docs/content/design.rst @@ -9,3 +9,12 @@ CPS Temporal Design =================== .. warning:: Draft + +* REST API + + * Specification + * Postman Collection + +* Event Schema + + * Json Schema diff --git a/docs/index.rst b/docs/index.rst index a491bfa..ebaad15 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,12 +4,12 @@ .. .. Copyright (C) 2021 Bell Canada +.. _master_index: + ============ CPS Temporal ============ -.. warning:: Draft - .. toctree:: :maxdepth: 1 @@ -18,5 +18,5 @@ CPS Temporal content/design.rst content/modeling.rst content/deployment.rst - content/apis.rst + content/admin-guide.rst content/release-notes.rst |