Skip to content
This repository has been archived by the owner on Sep 14, 2020. It is now read-only.

Re-structure the docs into sections #325

Merged
merged 9 commits into from
Mar 11, 2020

Conversation

nolar
Copy link
Contributor

@nolar nolar commented Mar 9, 2020

What do these changes do?

Re-structures the documentation into multiple sections, and extracts some common topics from the Handlers page to their own (kwargs, error handling, filtering, etc).

Description

As new types of handlers and decorators are being added (e.g. activities), the docs were growing and eventually ended up being overloaded with informations. As even more handlers are going to appear soon (e.g. daemons & timers), it requires re-structuring the docs, specifically extracting some common topics as separate pages.

Some new docs are also written: slightly more verbose on kwargs, totally new for results delivery.

A preview is temporarily available at:

Issues/PRs

Issues: #12 #19

Type of changes

  • Mostly documentation and examples (no code changes)

Checklist

  • The code addresses only the mentioned problem, and this problem only
  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt

@nolar nolar added the documentation Documentation improvements label Mar 9, 2020
@zincr
Copy link

zincr bot commented Mar 9, 2020

🤖 zincr found 0 problems , 1 warning

ℹ️ Large Commits
✅ Approvals
✅ Specification
✅ Dependency Licensing

Details on how to resolve are provided below


Large Commits

Checks all commits for large additions to a single file. Large commits should be reviewed more carefully for potential copyright and licensing issues

This file contains a substantial change, please review to determine if the change comes from an external source and if there are any copyright or licensing issues to be aware of

  • ℹ️ docs/handlers.rst had +100 lines of code changed in a single commit
    Please review this file to determine the source of this change
  • ℹ️ docs/kwargs.rst had +100 lines of code changed in a single commit
    Please review this file to determine the source of this change
     

@zincr
Copy link

zincr bot commented Mar 9, 2020

🤖 zincr found 1 problem , 1 warning

❌ Approvals
ℹ️ Large Commits
✅ Specification
✅ Dependency Licensing

Details on how to resolve are provided below


Approvals

All proposed changes must be reviewed by project maintainers before they can be merged

Not enough people have approved this pull request - please ensure that 1 additional user, who have not contributed to this pull request approve the changes.

  • ✅ Approved by PR author @nolar
  • ❌ 1 additional approval needed
     

Large Commits

Checks all commits for large additions to a single file. Large commits should be reviewed more carefully for potential copyright and licensing issues

This file contains a substantial change, please review to determine if the change comes from an external source and if there are any copyright or licensing issues to be aware of

  • ℹ️ docs/handlers.rst had +100 lines of code changed in a single commit
    Please review this file to determine the source of this change
  • ℹ️ docs/kwargs.rst had +100 lines of code changed in a single commit
    Please review this file to determine the source of this change
     

docs/results.rst Outdated Show resolved Hide resolved
docs/kwargs.rst Outdated Show resolved Hide resolved
docs/results.rst Outdated Show resolved Hide resolved
@nolar nolar merged commit 2c71453 into zalando-incubator:master Mar 11, 2020
@nolar nolar deleted the doc-common-aspects-as-pages branch March 11, 2020 09:50
@nolar nolar added this to the 0.27 milestone May 11, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants