main.md -> README, docs changelog

Signed-off-by: Trishna Guha <[email protected]>
acozine · May 17, 2018 · e77014b · e77014b
1 parent 850e433
commit e77014b
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 3 deletions.
diff --git a/ANNOUNCE.md b/ANNOUNCE.md
@@ -25,5 +25,5 @@ Via Ansible Galaxy using the following Linux command:
 
 How do I use it?
 ----------------------------------
-See the [User Guide](https://github.com/ansible-network/network-engine/blob/devel/docs/user_guide/main.md) for details and examples.
+See the [User Guide](https://github.com/ansible-network/network-engine/blob/devel/docs/user_guide/README.md) for details and examples.
 
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -7,6 +7,14 @@ Ansible Network: network-engine
 v2.5.1
 ======
 
+.. _Ansible Network: network-engine_v2.5.1_Documentation Updates:
+
+Documentation Updates
+---------------------
+
+- User Guide `docs/user_guide <https://github.com/ansible-network/network-engine/tree/devel/docs/user_guide>`_.
+
+
 .. _Ansible Network: network-engine_v2.5.1_Deprecated Features:
 
 Deprecated Features

diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ To see the version of this role you currently have installed: `ansible-galaxy li
 
 To ensure you have the latest version available: `ansible-galaxy install -f ansible-network.network-engine`
 
-To use this role, follow the [User Guide](https://github.com/ansible-network/network-engine/blob/devel/docs/user_guide/main.md).
+To use this role, follow the [User Guide](https://github.com/ansible-network/network-engine/blob/devel/docs/user_guide/README.md).
 
 To find other roles maintained by the Ansible Network team, see our [Galaxy Profile](https://galaxy.ansible.com/ansible-network/). 
 
@@ -24,7 +24,7 @@ Interested in contributing to this role? Check out [CONTRIBUTING](https://github
 ## Documentation
 
 * User guide:
-    - [How to use](https://github.com/ansible-network/network-engine/blob/devel/docs/user_guide/main.md)
+    - [How to use](https://github.com/ansible-network/network-engine/blob/devel/docs/user_guide/README.md)
     - [Parser Directives](https://github.com/ansible-network/network-engine/blob/devel/docs/directives/parser_directives.md)
 * Development guide: [How to test](https://github.com/ansible-network/network-engine/blob/devel/docs/tests/test_guide.md)
 

diff --git a/changelogs/config.yaml b/changelogs/config.yaml
@@ -18,3 +18,4 @@ sections:
 - ['new_modules', 'New Modules']
 - ['bugfixes', 'Bugfixes']
 - ['known_issues', 'Known Issues']
+- ['docs', 'Documentation Updates']
diff --git a/changelogs/fragments/v251-docs.yaml b/changelogs/fragments/v251-docs.yaml
@@ -0,0 +1,2 @@
+docs:
+- User Guide `docs/user_guide <https://github.com/ansible-network/network-engine/tree/devel/docs/user_guide>`_.
diff --git a/docs/user_guide/main.md → docs/user_guide/README.md b/docs/user_guide/main.md → docs/user_guide/README.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		docs:
		- User Guide `docs/user_guide <https://github.com/ansible-network/network-engine/tree/devel/docs/user_guide>`_.