Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation for new developers #1426

Closed
28 of 32 tasks
brew opened this issue Mar 5, 2019 · 6 comments
Closed
28 of 32 tasks

Update documentation for new developers #1426

brew opened this issue Mar 5, 2019 · 6 comments
Labels
in progress
Projects
Cleanup July 2020

Comments

@brew
Copy link
Contributor

brew commented Mar 5, 2019 •
edited

Ensure documentation is up to date, with a view to getting new developers up to speed with starting development on the Openspending platform.

Installation, testing and local development instructions should be on the individual repo READMEs and openspending/openspending, and out of date instructions removed from docs.openspending.org (https://github.com/openspending/docs).

  • openspending
  • os-nginx-frontend
  • os-explorer
  • os-packager
  • os-viewer
  • os-admin
  • os-api
  • os-conductor
  • os-auth-client
  • os-fdp-adaptors
  • os-api-cache
  • os-package-registry
  • os-data-importers
  • os-source-specs
  • repository-agent
  • datapackage-pipelines-fiscal
  • os-types
  • os-dpp-runner
brew added a commit to openspending/os-api that referenced this issue Mar 7, 2019
@brew
Move developer docs to README
81542be 
Part of openspending/openspending#1426
brew added a commit to openspending/os-conductor that referenced this issue Mar 7, 2019
@brew
Move developer docs to README
88252cd 
Part of openspending/openspending#1426.
brew added a commit to openspending/os-packager that referenced this issue Mar 7, 2019
@brew
Move developer docs to README
3d0c142 
Part of openspending/openspending#1426
brew added a commit to openspending/os-viewer that referenced this issue Mar 7, 2019
@brew
Move developer docs to README
50c4301 
Part of openspending/openspending#1426
brew added a commit to openspending/os-explorer that referenced this issue Mar 7, 2019
@brew
Update README
85091f0 
Part of openspending/openspending#1426
brew added a commit to openspending/os-cli that referenced this issue Mar 7, 2019
@brew
Move developer docs to README
2212e97 
(I haven't investigated whether os-cli works at all given the move to OS
2. This commit adds the developer documentation from the Read the Docs
documentation to this readme.)

Part of openspending/openspending#1426
@roll
Copy link

roll commented Mar 13, 2019 •
edited

@brew
Here's my quick overview and an attempt to run things.
Here I do things if I (which is not far away from reality=):

  • have no idea about OpenSpending
  • a designer who just needs to run some app and fix some design OR
  • something similar

So I just try to do what readmes say.
Sorry if there are mistakes from my side I had very limited time to try a lot)

  • ReadTheDocs
    • developers-contributors-users - for me it was kinda confusing classification. I mean Code contributorss vs Data contributors
    • getting started sections is kinda confusing because it contains links to following sections in the middle (breaking read as a book flow)
    • I wouldn't bind user-facing docs with any mentions of underlaying services (as a user I probably don't care that app's name is "Viewer" etс). But I'm not sure on it..
    • https://docs.openspending.org/en/latest/contributors/prepare/ - goodtables cli example outdated
    • https://docs.openspending.org/en/latest/contributors/use/ - empty
  • openspending
    • cannot start service db/es/.. ERROR: for openspending_db_1 Cannot start service db: driver failed programming external connectivity on endpoint openspending_db_1 (eb8a82aa15366ed6d4e19373686714105f8c4faa59af96398d6ee68c81fee082): Error starting userland proxy: listen tcp 0.0.0.0:5432: bind
  • os-explorer
    • no .env.example
    • no OS_BASE_URL explanation for dev
    • no docs/notes about docker build
    • no node@8 requirement in the readme
  • os-packager
    • no OS_BASE_URL explanation for dev
    • no node@8 requirement in the readme
    • no docs/notes about docker build
    • OS_PACKAGER_BASE_PATH= is required not optional
  • os-viewer
    • no .env.example
    • no OS_BASE_URL explanation for dev
    • no node@8 requirement in the readme
    • npm install - super weird but fails with a lot of ENOENT: no such file or directory (fixed by removing package-lock.json)
    • no npm test in readme
    • OS_VIEWER_BASE_PATH= is required not optional
    • no docs/notes about docker build
    • npm start
      • loading if base=localhost
      • redirect to openspending if base=openspending
  • os-admin
    • no OS_BASE_URL explanation for dev
    • no node@8 requirement in the readme
    • no docs/notes about docker build
  • os-api
    • no .env.example
    • no docs/notes about docker build
    • no command to install dependencies in readme
    • python dev_server.py - fails because I need to setup services (should I use info from the "testing" session for dev?)

@roll
Copy link

roll commented Mar 13, 2019 •
edited

And BTW the work on the docs is very impressive in general 👍

@brew
Copy link
Contributor Author

brew commented Mar 13, 2019

Thanks - can you tell me what command you used when you received the ERROR: for openspending_db_1 Cannot start service db error?

@roll
Copy link

roll commented Mar 13, 2019

@brew
Sorry I missed it out

docker-compose -f docker-compose.base.yml -f docker-compose.dev-services.yml  up

My error is something like this docker/compose#3277

@brew
Copy link
Contributor Author

brew commented Mar 13, 2019

Perhaps this is a docker-compose issue? Which version are you running (docker-compose -v)? I'm using docker-compose version 1.23.2, build 1110ad01.

@roll roll removed their assignment Aug 8, 2019
@sglavoie
Copy link
Contributor

WONTFIX/CLEANUP: Closing old issue without recent activity (>1 year) nor assignee as part of #1478. Data will be migrated and merged into the DataHub.io platform. Please feel free to re-open if this is still relevant.

@sglavoie sglavoie added this to Closed in Cleanup July 2020 Jul 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
in progress
Projects
No open projects
Cleanup July 2020
Closed
Milestone
No milestone
Development

No branches or pull requests
3 participants
@brew @roll @sglavoie