Shields: Document private/secret.json

[niccokunzmann]

private/secret.json contains all information necessary to use APIs with authentication.

Please add the following to the documentation:

• In the INSTALL.md
  
  
  
  • [ ] a JSON example that shows the form but is not usable
  
  
  • [ ] What the output means and that the server works without
  
  
  • for each attribute
  
  
  • bintray_apikey and bintray_user
    
    
    
    
    
    • [ ] What is it for and what can you do with it.
    
    
    
    • [ ] How to generate it
    
    
    
    • [ ] Examples that describe the form
    
    
    
    • [ ] How to check if it works
    
    
    
  
  
  • gh_client_id and gh_client_secret
    
    
    
    
    
    • [ ] What is it for and what can you do with it.
    
    
    
    • [ ] How to generate it
    
    
    
    • [ ] Examples that describe the form
    
    
    
    • [ ] How to check if it works
    
    
    
  
  
  • shieldsIps and shieldsSecret
    
    
    
    
    
    • [ ] What is it for and what can you do with it.
    
    
    
    • [ ] How to generate it
    
    
    
    • [ ] Examples that describe the form
    
    
    
    • [ ] How to check if it works
    
    
    
  
  
  • sl_insight_apiToken and sl_insight_userUuid
    
    
    
    
    
    • [ ] What is it for and what can you do with it.
    
    
    
    • [ ] How to generate it
    
    
    
    • [ ] Examples that describe the form
    
    
    
    • [ ] How to check if it works
    
    
    
  
  
  • [ ] add a description of what the documentation requires if you add a new attribute
  
  
  • [ ] Link to tutorial
  
  
• [ ] Fill the tutorial section about authentication
  
  
  
  • [ ] How to add a new attribut
  
  
  • [ ] How to check if it is present
  
  
  • [ ] Link to secrets section
  
  

Further Reading:

• Related issues: #593 #747
• Related Code:
  
  
  
  • https://github.com/badges/shields/blob/master/server.js#L36
  
  
  • Search for serverSecrets
  
  
• Tutorial
• secrets section

[paulmelnikow]

There was some discussion of this in #2573. Let's tackle it in some form.

[chris48s]

I've made a start on this. Will try and get a PR submitted in next few days

[paulmelnikow]

Thanks for sorting this!