datopian / datopian/aircan

[BUG] Documentation not complete or outdated

Open
#99 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
34
Forks
8
Avg merge
2d 22h
Merged PRs (30d)
1

Description

I'm currently following the README.md documentation and I've found a few issues that I'll enumerate here:

  1. The first AirFlow DAG fails according to the airflow UI but there is a correct json output found on disk.

  2. Using Aircan DAGs should redirect to a dataset already for the first test, it only names my-dataset but this is not enough to quickly have a running example, instead there is more complexity to find a dataset that can be used here.

  3. In the GCP composer create should be added that the Image version is mandatory and there is no default for GCP, if no image version is given, the instance fails to start and is impossible to stop it.

  4. On the GCP example, when asked to override the parameters, there is nothing there now
    Original image:
    image

Now:
image

Even clicking EDIT does not give an option to override the params

  1. Names an Example 2 but the examples are not enumerated.

image

  1. For the same item, asks to add CKAN_SITE_URL and CKAN_SYSADMIN_API_KEY as Variables but first, there is no example 2 second what value should they contain?

Will add new items while I find them.

Also I will be updating the README.md for the things that I do find the solution by myself

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with README.md and reproduce the first Airflow DAG example, then review the Aircan DAG dataset guidance and GCP Composer sections. Check the documented image-version requirement, parameter override instructions, example numbering, and CKAN variable values against the observed UI and outputs. Done means the README provides working, complete instructions for each listed example.

Written by the indexing model from the issue text.

Assessment

Tech stack
google-cloud, python
Domain
cloud, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.