improve documentation

- add debugging chapter
- fix lint warnings
This commit is contained in:
mampfes
2022-01-22 17:34:13 +01:00
parent 1ae0c594de
commit 610e5c113d
24 changed files with 95 additions and 32 deletions

View File

@@ -9,7 +9,7 @@ waste_collection_schedule:
sources:
- name: aucklandcouncil_govt_nz
args:
area_number: AREA_NUMBER_FROM_COLLECTION_PAGE # see 'How to get the source argumnet below'
area_number: AREA_NUMBER_FROM_COLLECTION_PAGE # see 'How to get the source argument below'
```
### Configuration Variables
@@ -28,7 +28,9 @@ waste_collection_schedule:
```
## How to get the source argument
The source argument is the area number from Auckland Council site:
- Open your collection days page by entering your address [on the Auckland Council collection day finder](https://www.aucklandcouncil.govt.nz/rubbish-recycling/rubbish-recycling-collections/Pages/rubbish-recycling-collection-days.aspx)
- Look for 'an' parameter in your browser URL, e.g. https://www.aucklandcouncil.govt.nz/rubbish-recycling/rubbish-recycling-collections/Pages/collection-day-detail.aspx?an=12342306525
- In this example the area number is 12342306525 .
- Open your collection days page by entering your address [on the Auckland Council collection day finder](https://www.aucklandcouncil.govt.nz/rubbish-recycling/rubbish-recycling-collections/Pages/rubbish-recycling-collection-days.aspx)
- Look for 'an' parameter in your browser URL, e.g. https://www.aucklandcouncil.govt.nz/rubbish-recycling/rubbish-recycling-collections/Pages/collection-day-detail.aspx?an=12342306525
- In this example the area number is `12342306525`.