diff --git a/docs/design-guides.rst b/docs/design-guides.rst new file mode 100644 index 000000000..47c8d511c --- /dev/null +++ b/docs/design-guides.rst @@ -0,0 +1,9 @@ +Design guides +========================= + +.. toctree:: + :maxdepth: 4 + :glob: + + design-guides/cc-plugin + diff --git a/docs/design-guides/cc-plugin.rst b/docs/design-guides/cc-plugin.rst new file mode 100644 index 000000000..ceaa72484 --- /dev/null +++ b/docs/design-guides/cc-plugin.rst @@ -0,0 +1,15 @@ +Config Client Plugin +==================== + +Config Client +############# +Go-Chassis provides the functionality to pull the configs from different config-centers, to keep the go-chassis extensible to support multiple config-center this Client was implemented as a plugin. + +More Details of the plugin can be found `here <../dev-guides/archaius-config-source-plugin>`_ + +Currently Go-Chassis has two implementation of this plugin for Huawei Config-Center and Ctrip Apollo Config-Center. + +Basic Sequence diagram for this plugin is given below. + + .. image:: images/CC-Plugin.png + :alt: CC Plugin Sequence Diagram \ No newline at end of file diff --git a/docs/design-guides/images/CC-Plugin.png b/docs/design-guides/images/CC-Plugin.png new file mode 100644 index 000000000..16213e1ad Binary files /dev/null and b/docs/design-guides/images/CC-Plugin.png differ diff --git a/docs/dev-guides.rst b/docs/dev-guides.rst index 259ec9d73..66bc4cac9 100644 --- a/docs/dev-guides.rst +++ b/docs/dev-guides.rst @@ -2,12 +2,12 @@ Development guides ========================= .. toctree:: - :maxdepth: 4 - :glob: +:maxdepth: 4 + :glob: - dev-guides/how-to-implement-handler - dev-guides/archaius - dev-guides/archaius-config-source-plugin - dev-guides/how-to-write-cipher - dev-guides/how-to-extend-protocol + dev-guides/how-to-implement-handler + dev-guides/archaius + dev-guides/archaius-config-source-plugin + dev-guides/how-to-write-cipher + dev-guides/how-to-extend-protocol diff --git a/docs/index.rst b/docs/index.rst index c8307c6ec..cd16eecc1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -22,6 +22,11 @@ Welcome to go-chassis's documentation! dev-guides +.. toctree:: + :maxdepth: 2 + :caption: Design Documentations + + design-guides