Add Nexus 2 documentation 66/10666/3
authorJessica Wagantall <jwagantall@linuxfoundation.org>
Wed, 16 May 2018 05:14:48 +0000 (22:14 -0700)
committerJessica Wagantall <jwagantall@linuxfoundation.org>
Fri, 18 May 2018 23:03:11 +0000 (16:03 -0700)
Add Nexus 2 Repository Manager documentation
- Add basic introduction
- Add explanation on how to browse
- Add helpful images

Issue: RELENG-952
Change-Id: I0b16dfc6f163d984e317d21907652844800e15b8
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
docs/_static/nexus2-browse.png [new file with mode: 0644]
docs/_static/nexus2-content.png [new file with mode: 0644]
docs/_static/nexus2-ui.png [new file with mode: 0644]
docs/index.rst
docs/nexus2.rst [new file with mode: 0644]

diff --git a/docs/_static/nexus2-browse.png b/docs/_static/nexus2-browse.png
new file mode 100644 (file)
index 0000000..bf7d13e
Binary files /dev/null and b/docs/_static/nexus2-browse.png differ
diff --git a/docs/_static/nexus2-content.png b/docs/_static/nexus2-content.png
new file mode 100644 (file)
index 0000000..cd714c3
Binary files /dev/null and b/docs/_static/nexus2-content.png differ
diff --git a/docs/_static/nexus2-ui.png b/docs/_static/nexus2-ui.png
new file mode 100644 (file)
index 0000000..2fdd414
Binary files /dev/null and b/docs/_static/nexus2-ui.png differ
index 3e4c205..99d3491 100644 (file)
@@ -18,6 +18,7 @@ Guides:
    gpg
    jenkins
    project-documentation
+   nexus2
 
 .. TODO Jenkins (RELENG-510)
 .. TODO Release Workflow (RELENG-511)
diff --git a/docs/nexus2.rst b/docs/nexus2.rst
new file mode 100644 (file)
index 0000000..c0dae32
--- /dev/null
@@ -0,0 +1,42 @@
+.. _nexus2-guide:
+
+#############
+Nexus 2 Guide
+#############
+
+LF projects use Nexus Repository Manager 2 to store Maven and Java based artifacts.
+It helps organizing dependencies and releases.
+
+.. note::
+
+   More information in the Sonatype webpage:
+   https://books.sonatype.com/nexus-book/
+
+   And Nexus Repository Manager 2 specifics:
+   https://help.sonatype.com/repomanager2
+
+To access Nexus 2 for a particular project, use URL:
+``https://nexus.PROJECT_DOMAIN``
+
+.. image:: _static/nexus2-ui.png
+   :alt: Nexus Repository Manager 2 main view.
+   :align: center
+
+Users do not need to login using their LFID credentials. LF admin teams and LFRE
+engeneers should  login to access the administator options.
+Other users can browse the repositories and proxies anonymously.
+
+.. image:: _static/nexus2-browse.png
+   :alt: Nexus Repository Manager 2 browse view.
+   :align: center
+
+Alternately, users can access the repositories outside the GUI using the URL:
+``https://nexus.PROJECT_DOMAIN/content/repositories/``
+
+.. image:: _static/nexus2-content.png
+   :alt: Nexus Repository Manager 2 content view.
+   :align: center
+
+Nexus 2 communicates with Jenkins server which is the interface used to make
+the artifacts publications on a scheduled or by demand basis (depending on the Jenkins JJB
+configuration for the particuar job).