search

github / maven-plugins

Official GitHub Maven Plugins
MIT License
584 stars 198 forks source link

Doc error in README `mvn site` #119

Open mikesamuel opened 7 years ago

mikesamuel commented 7 years ago

The README.md says

To commit a created site run the following command:

$ mvn site

This doesn't work with the configuration listed therein since this is interpreted as mvn site:site.

mvn com.github.github:site-maven-plugin:site is clunky but should work for many configurations.

The pom prefix suggests that mvn ghSite:site should work, but it doesn't for me.

mikesamuel commented 7 years ago

Also, the "Github oauth support" link in authentication.md is split over two lines which breaks the link.

This is what I see on https://github.github.com/maven-plugins/site-plugin/authentication.html

Using oauth is quite similar. Once you have done all the preliminaries (see [GitHub OAuth support](http://developer .github.com/v3/oauth/)), add a server entry as follows:

Note the space between "developer" and ".github..."