Provide a link to internal Documentation on how to use NPM

[marcellodesales]

We are looking at a way to give users a link to the internal documentation on how to use NPM... For instance, when we login at the internal GitHub Enterprise, new users are given a nice introduction about how to publish a new repository...

Maybe this could be done with #108, and that could show a profile page showing all the steps that the user needs to know, be aware of, understand, and properly setup. Specially with the new concept of scopes, which is new...

What we Did

What I ended up doing was to add a link back to our internal wiki page.

I added a volume that overrides the default implementation of the front page showing the top link.

Requirement

• Provide a simplified way to show the steps to use NPMO:
  • How to login
  • How to install a given NPM module
  • How to Publish a given NPM module: This is the tricky part, where we could add a hook to display all the URLs for our GitHub Enterprise

[kevinSuttle]

@marcellodesales How did you add a link in there?

[marcellodesales]

@kevinSuttle here's the procedure, which is very weak patching of the existing source-code:

• 1. docker cp newww:/etc/npme/node_modules/newww/templates/layouts/default.hbs /tmp/patch.hbs
• 2. Patch the file with the following:

    {{#if features.npmo}}

      <nav>
        <a href="https://wiki.mycompany.com/display/nodejs/Intuit+NPM+Registry" style="color: #4E6DCC;">tutorial</a>
        <a href="https://docs.npmjs.com">docs</a>
        <a href="https://goo.gl/CihCMg">support</a>
      </nav>

    {{else}}

• 3. Start the newww container with the patch.

newwwData:
  image: busybox
  volumes:
    - ./patches/newww/templates-layouts-default.hbs-with-tutorial:/etc/npme/node_modules/newww/templates/layouts/default.hbs

I usually update the newww version and I need to re-patch it. So, have to be careful with this.