Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Reorganize "Incoming webhooks" section of API docs. #13511

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

drrosa
Copy link
Collaborator

@drrosa drrosa commented Dec 11, 2019

  • Rename "Integrations" section to "Incoming webhooks".
  • Rename "Incoming webhook integrations" item to just "Integrations".
  • Rename "Non-webhook integrations" item to "Other integrations".
  • Add new "Generic webhooks" item that links to the REST API page.

Discussion:
https://chat.zulip.org/#narrow/stream/31-production-help/topic/webhooks/near/801262

@timabbott
Copy link
Sponsor Member

I'm not happy with how this ends up feeling, though I think it's progress. I pushed back here with some naming edits.

I think the next thing to try is if merging the "Overview" page to be the bottom of the "Home" page (/api/) would improve things, since that section is clearly not intended to be scoped within the "Incoming webhooks" section.

* Rename "Integrations" section to "Incoming webhooks".
* Rename "Incoming webhook integrations" item to "Webhook integrations".
* Rename "Hello world walkthrough" item to "Integration walkthrough".
* Rename "Non-webhook integrations" item to "Other integrations".
* Add new "Generic incoming webhook" item that links to api/send-message
@drrosa
Copy link
Collaborator Author

drrosa commented Dec 11, 2019

Yeah, that does appear to improve things. I left the headings unchanged after merging the Integrations Overview page though.

It just didn't look right to me after increasing the level of headings. But not sure if it would be acceptable to have two top-level headings in the /api home page. What do you think?

@zulipbot
Copy link
Member

zulipbot commented May 6, 2020

Heads up @drrosa, we just merged some commits that conflict with the changes your made in this pull request! You can review this repository's recent commits to see where the conflicts occur. Please rebase your feature branch against the upstream/master branch and resolve your pull request's merge conflicts accordingly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants