Merge pull request #121 from s1cyan/doc-changes-0.3

Copyright changes + login blurb change
kabanero-io · Nov 1, 2019 · 897ebb9 · 897ebb9
2 parents a6d1f0f + 222ec08
commit 897ebb9
Show file tree

Hide file tree

Showing 9 changed files with 12 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -40,9 +40,10 @@ Will authenticate you to a Kabanero instance
 ### Synopsis
 
 
-	Login to a Kabanero instance using Github credentials, and store a temporary access token for subsequent command line calls.
+	Logs in to a Kabanero instance using Github credentials, and stores a temporary access token for subsequent command line calls.
 	The temporary authentication token will be stored in your-home-directory/.kabanero/config.yaml.
 	Use your Github userid and either password or Personal Access Token (PAT).
+	* If you use a GitHub Personal Access Token, make sure it has **read:org** - Read org and team membership, read org projects OAuth Scope allowed. You can select this when creating your PAT in GitHub.
 
 
 ```

diff --git a/cmd/activate.go b/cmd/activate.go
@@ -1,5 +1,5 @@
 /*
-Copyright © 2019 NAME HERE <EMAIL ADDRESS>
+Copyright © 2019 IBM Corporation and others.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/cmd/deactivate.go b/cmd/deactivate.go
@@ -1,5 +1,5 @@
 /*
-Copyright © 2019 NAME HERE <EMAIL ADDRESS>
+Copyright © 2019 IBM Corporation and others.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/cmd/list.go b/cmd/list.go
@@ -1,5 +1,5 @@
 /*
-Copyright © 2019 NAME HERE <EMAIL ADDRESS>
+Copyright © 2019 IBM Corporation and others.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/cmd/login.go b/cmd/login.go
@@ -1,5 +1,5 @@
 /*
-Copyright © 2019 NAME HERE <EMAIL ADDRESS>
+Copyright © 2019 IBM Corporation and others.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -42,9 +42,10 @@ var loginCmd = &cobra.Command{
 	Use:   "login kabanero-url -u Github userid -p Github-PAT|Github-password ",
 	Short: "Will authenticate you to a Kabanero instance",
 	Long: `
-	Login to a Kabanero instance using Github credentials, and store a temporary access token for subsequent command line calls.
+	Logs in to a Kabanero instance using Github credentials, and stores a temporary access token for subsequent command line calls.
 	The temporary authentication token will be stored in your-home-directory/.kabanero/config.yaml.
 	Use your Github userid and either password or Personal Access Token (PAT).
+	* If you use a GitHub Personal Access Token, make sure it has **read:org** scope. You can select this when creating your PAT in GitHub
 	`,
 	Example: `
 	# login with Github userid and password:

diff --git a/cmd/logout.go b/cmd/logout.go
@@ -1,5 +1,5 @@
 /*
-Copyright © 2019 NAME HERE <EMAIL ADDRESS>
+Copyright © 2019 IBM Corporation and others.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/cmd/onboard.go b/cmd/onboard.go
@@ -1,5 +1,5 @@
 /*
-Copyright © 2019 NAME HERE <EMAIL ADDRESS>
+Copyright © 2019 IBM Corporation and others.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/cmd/sync.go b/cmd/sync.go
@@ -1,5 +1,5 @@
 /*
-Copyright © 2019 NAME HERE <EMAIL ADDRESS>
+Copyright © 2019 IBM Corporation and others.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/cmd/version.go b/cmd/version.go
@@ -1,4 +1,4 @@
-// Copyright © 2019 NAME HERE <EMAIL ADDRESS>
+// Copyright © 2019 IBM Corporation and others.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.