Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Discussion of what to do for the "info" link in the service specification:

 

Use a Readme

...

  • Require every user to include a readme with their service PR following a certain template

Pros:

  • Everything is in the ndslabs-spec repo

Cons:

  • Editing requires PR
  • Developer centric

Use the Github wiki

 

 

Pros:

  • Everything is centralized in Git
  • Can support PR model, but not required
  • Can allow true wiki-style editing (not so formal as requiring a PR) if we want

Cons:

  • Wiki is separate from Repo.
  • Developer centric

Use the NDS wiki

Pros:

  • Makes use of the Atlassian wiki
  • Nice central repo for non-developer types

Cons

  • Requires NDS user account Use the nationaldataservice.Atlassian wiki