From e5f259fa8b37200f0130ce9b4ce3ef70c7ee22b4 Mon Sep 17 00:00:00 2001 From: Vitor Baptista Date: Fri, 15 Dec 2017 20:57:06 +0000 Subject: [PATCH] [#213] Reorganize files into folders This makes the URIs nicer. --- docs/{api.md => api/index.md} | 2 +- docs/{ => configuration}/goodtables_yml.md | 0 docs/{configuring.md => configuration/index.md} | 0 .../github.md} | 0 docs/{getting_started.md => getting_started/index.md} | 4 ++-- docs/{getting_started_s3.md => getting_started/s3.md} | 2 +- docs/{ => getting_started}/writing_data_schema.md | 0 docs/index.md | 8 ++++---- 8 files changed, 8 insertions(+), 8 deletions(-) rename docs/{api.md => api/index.md} (87%) rename docs/{ => configuration}/goodtables_yml.md (100%) rename docs/{configuring.md => configuration/index.md} (100%) rename docs/{getting_started_github.md => getting_started/github.md} (100%) rename docs/{getting_started.md => getting_started/index.md} (64%) rename docs/{getting_started_s3.md => getting_started/s3.md} (99%) rename docs/{ => getting_started}/writing_data_schema.md (100%) diff --git a/docs/api.md b/docs/api/index.md similarity index 87% rename from docs/api.md rename to docs/api/index.md index f4f39a78..ff9b9df4 100644 --- a/docs/api.md +++ b/docs/api/index.md @@ -8,7 +8,7 @@ your authorization token via the `Authorization` header. ## Endpoints ```eval_rst -.. openapi:: ../goodtablesio/schemas/openapi-v1.yml +.. openapi:: ../../goodtablesio/schemas/openapi-v1.yml ``` diff --git a/docs/goodtables_yml.md b/docs/configuration/goodtables_yml.md similarity index 100% rename from docs/goodtables_yml.md rename to docs/configuration/goodtables_yml.md diff --git a/docs/configuring.md b/docs/configuration/index.md similarity index 100% rename from docs/configuring.md rename to docs/configuration/index.md diff --git a/docs/getting_started_github.md b/docs/getting_started/github.md similarity index 100% rename from docs/getting_started_github.md rename to docs/getting_started/github.md diff --git a/docs/getting_started.md b/docs/getting_started/index.md similarity index 64% rename from docs/getting_started.md rename to docs/getting_started/index.md index 279f913c..22356e4b 100644 --- a/docs/getting_started.md +++ b/docs/getting_started/index.md @@ -4,7 +4,7 @@ .. toctree:: :maxdepth: 2 - getting_started_github - getting_started_s3 + github + s3 writing_data_schema ``` diff --git a/docs/getting_started_s3.md b/docs/getting_started/s3.md similarity index 99% rename from docs/getting_started_s3.md rename to docs/getting_started/s3.md index 2b9f3565..2361143b 100644 --- a/docs/getting_started_s3.md +++ b/docs/getting_started/s3.md @@ -18,7 +18,7 @@ This is a very short tutorial on using goodtables.io to continuously validate da 1. Go to your [bucket's overview page][bucket-overview], click on the `Permissions` tab, and find the `Bucket Policy` link. We need the permissions: * _s3:ListBucket_: To list the bucket's contents * _s3:GetObject_: To read the bucket's files - * _s3:GetBucketPolicy_, _s3:PutBucketPolicy_, _s3:GetBucketLocation_, and _s3:PutBucketNotification_: To set up the AWS Lambda functions that notifies goodtables.io when a new file is added. + * _s3:GetBucketPolicy_, _s3:PutBucketPolicy_, _s3:GetBucketLocation_, and _s3:PutBucketNotification_: To set up the AWS Lambda functions that notifies goodtables.io when a new file is added The final bucket policy should look like: diff --git a/docs/writing_data_schema.md b/docs/getting_started/writing_data_schema.md similarity index 100% rename from docs/writing_data_schema.md rename to docs/getting_started/writing_data_schema.md diff --git a/docs/index.md b/docs/index.md index a0a797ff..e09e1924 100644 --- a/docs/index.md +++ b/docs/index.md @@ -29,10 +29,10 @@ data is free from these types of errors. .. toctree:: :maxdepth: 2 - getting_started - configuring - goodtables_yml - api + getting_started/index + configuration/index + configuration/goodtables_yml + api/index ```