Currently api.archivers.co points to a page with only the response:

{ "status" :  "not found" }

It would be great if this went somewhere more useful. Potential options are:

1. redirect to /docs UI
2. provide a summary of all the top-level endpoints like other api sometimes do

My personal feeling is that (1) is more helpful, but curious to hear others' feeling.

Note: I'd like to convert this into a first-timers-only issue once we have a clear path forward.

cc: @b5

Can we describe the "huge pain" of updating code in more detail, preferably in issues here that can be tackled by ocntributers?

currently api responses don't properly populate pagination data, the apiutil package should make sure that happens properly

This is beginner task tagged as first-timers-only, and is prepared specifically to be taken on by someone who is new to the Data Together project. If this is you: Yay! Welcome aboard! 😄

The API provided by this repo has a documentation website. It is generated from these instructions:
https://github.com/datatogether/api#generating-documentation

It is generated from a formatted YAML file, which describes how a person or program could interact with it. Since the YAML file is written according to the Swagger API spec, using that file can generate documentation and even libraries in many language that will help people talk to the API.

• open_api.yaml config file of GitHub
  • view in Swagger Editor

Right now, the /customcrawl endpoint that needs documenting is only described in the code itself:

• api/server.go

  Lines 111 to 112 in fa6335a

  	m.Handle("/customcrawls", middleware(CustomCrawlsHandler))
  	m.Handle("/customcrawls/", middleware(CustomCrawlHandler))

• https://github.com/datatogether/api/blob/master/custom_crawl_handlers.go
• https://github.com/datatogether/core/blob/master/custom_crawl.go#L17

Could someone help us

Reticketed from action item on call: Data Together Tech Standup 2017-11-16

Make sure this repo has the following files:

• Readme README.md
  • Repo Badges for: Github Project, Slack, License
  • 1-3 sentence description of repository contents
  • Getting Involved section
  • Development section
• License -- LICENSE
• Contributing Guidelines (minimal and pointing to org-wide) .github/CONTRIBUTING.md
• Issue Template -- .github/ISSUE_TEMPLATE.md
• GitHub Description from 1-3 sentence readme blurb

This issue forms part of a project-wide meta-issue

Make sure this repo has the following files:

• Readme README.md
  • OOPS! Please note that the file paths in the README template need to be updated . Replace REPONAME with the name of hte repository!
  • Repo Badges for: Github Project, Slack, License
  • 1-3 sentence description of repository contents
  • Getting Involved section
  • Development section
• License -- LICENSE
• Contributing Guidelines (minimal and pointing to org-wide) .github/CONTRIBUTING.md
• Issue Template -- .github/ISSUE_TEMPLATE.md
• GitHub Description from 1-3 sentence readme blurb

This issue forms part of a project-wide meta-issue