Uploaded image for project: 'Logging analytics'
  1. Logging analytics
  2. LOG-49

Add formal documentation stub to http://onap.readthedocs.io

    XMLWordPrintable

Details

    • Story
    • Status: Closed
    • Highest
    • Resolution: Done
    • None
    • Amsterdam Release
    • None

    Description

      http://onap.readthedocs.io/en/latest/submodules/logging-analytics.git/docs/index.html

       use

      http://onap.readthedocs.io/en/latest/index.html

      http://onap.readthedocs.io/en/latest/guides/onap-developer/how-to-use-docs/index.html

      Destination: https://onap.readthedocs.io/en/latest/submodules/logging-analytics.git/docs/

       

      see reference from AAI

      https://gerrit.onap.org/r/#/c/15673/

       

       other subtasks

      https://jira.onap.org/browse/LOG-33

      https://jira.onap.org/browse/LOG-36

      https://jira.onap.org/browse/LOG-39

      https://jira.onap.org/browse/LOG-42

      https://jira.onap.org/browse/LOG-49

       

      follow what was done for integration project (step 1 = initial index = passed jenkins job for RC0)

      https://gerrit.onap.org/r/#/c/18415/

      obrienbiometrics:oom michaelobrien$ cd ../logging-analytics/
      obrienbiometrics:logging-analytics michaelobrien$ git status
      On branch master
      Your branch is up-to-date with 'origin/master'.
      Untracked files:
        (use "git add <file>..." to include in what will be committed)
      
      docs/
      
      nothing added to commit but untracked files present (use "git add" to track)
      obrienbiometrics:logging-analytics michaelobrien$ git add docs
      obrienbiometrics:logging-analytics michaelobrien$ git status
      On branch master
      Your branch is up-to-date with 'origin/master'.
      Changes to be committed:
        (use "git reset HEAD <file>..." to unstage)
      
      new file:   docs/index.rst
      
      obrienbiometrics:logging-analytics michaelobrien$ git commit -am "logging documentation initial empty index"
      [master 8fa3282] logging documentation initial empty index
      1 file changed, 8 insertions(+)
      create mode 100644 docs/index.rst
      obrienbiometrics:logging-analytics michaelobrien$ git review -s
      No '.gitreview' file found in this repository. We don't know where
      your gerrit is. Please manually create a remote named "gerrit" and try
      again.
      obrienbiometrics:logging-analytics michaelobrien$ git config --global gitreview.remote origin
      obrienbiometrics:logging-analytics michaelobrien$ git review -s
      obrienbiometrics:logging-analytics michaelobrien$ git commit -as --amend
      [master 295d1eb] logging documentation initial empty index
      Date: Wed Oct 11 22:40:35 2017 -0400
      1 file changed, 8 insertions(+)
      create mode 100644 docs/index.rst
      obrienbiometrics:logging-analytics michaelobrien$ git config --global format.signoff true
      obrienbiometrics:logging-analytics michaelobrien$ git review
      Warning: Permanently added '[gerrit.openecomp.org]:29418,[198.145.29.92]:29418' (RSA) to the list of known hosts.
      remote: Processing changes: new: 1, refs: 1, done            
      remote:
      remote: New Changes:        
      remote:   http://gerrit.onap.org/r/18415 logging documentation initial empty index        
      remote:
      To ssh://gerrit.openecomp.org:29418/logging-analytics
      * [new branch]      HEAD -> refs/publish/master

       next commit is to doc project like - https://gerrit.onap.org/r/#/c/16079/  which should fix https://jenkins.onap.org/job/doc-master-verify-rtd/551/

      https://lists.onap.org/pipermail/onap-discuss/2017-October/005507.html

       20171012 - following http://onap.readthedocs.io/en/latest/guides/onap-developer/how-to-use-docs/include-documentation.html#setup-project-repositories-s

       

       

      Attachments

        Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              michaelobrien Michael O'Brien
              michaelobrien Michael O'Brien
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: