docs: Improve Parent-child documentation to simplify and be clear

[MeltyBot]

Migrated from GitLab: https://gitlab.com/meltano/sdk/-/issues/298

Originally created by @rabidaudio on 2022-01-03 20:08:58

---

Raising a question that came up from my team while using the SDK.

One of my team members was confused by the Parent-Child streams docs. Specifically, they weren't sure how group_id was used in the path of EpicIssuesStream, they new it was in the context, but thought it was being set as an instance property and were confused why it wasn't working.

I explained that there was probably a method like this that was implied to exist, and that the SDK does parameter replacement in paths:

    def get_url_params(
        self, context: Optional[dict], next_page_token: Optional[Any]
    ) -> Dict[str, Any]:
       return { 'group_id': context['group_id'], 'epic_iid': context['epic_iid'], 'page': next_page_token }

Might be something to consider adding/refining.

[MeltyBot]

View 2 previous comments from the original issue on GitLab

[stale[bot]]

This has been marked as stale because it is unassigned, and has not had recent activity. It will be closed after 21 days if no further activity occurs. If this should never go stale, please add the evergreen label, or request that it be added.

[edgarrmondragon]

Still relevant

[stale[bot]]

This has been marked as stale because it is unassigned, and has not had recent activity. It will be closed after 21 days if no further activity occurs. If this should never go stale, please add the evergreen label, or request that it be added.