Docs: Move legacy docs pages and add admonitions#292
Conversation
* add a new file in rest api
|
|
||
| Refer to the README in the GitHub repository for further instructions on using the library, or review the code examples throughout this documentation. | ||
|
|
||
| API rate limiter |
There was a problem hiding this comment.
In the legacy repo, this is a standalone page: https://github.com/mautic/developer-documentation/blob/main/source/includes/_api_rate_limiter.md.
Can this be part of API intro here, or is it part of another page (if so, which one?), or should it be a standalone page as the legacy?
There was a problem hiding this comment.
The API rate limiter was removed, actually - since 7 I think. But we should have it there for legacy reasons. I think it makes sense having it in the API intro but open to thoughts on that from the devs.
There was a problem hiding this comment.
@escopecz do you have any thoughts about this?
There was a problem hiding this comment.
I'd remove it. One company added the feature and it was removed because there was no version of the library that would support new Symfony and PHP version. The company was notified about it in time and they didn't add a replacement so far. So I hope this feature won't be missed by anyone.
| @@ -1,7 +1,15 @@ | |||
| Channels | |||
There was a problem hiding this comment.
In the original version, "Channels" section is not available, and "Extending broadcast" sub-section in this page is a standalone page: https://github.com/mautic/developer-documentation/blob/main/source/includes/_plugin_extending_broadcasts.md.
Is this correct that "Channels" and "Extending broadcast" are in the same page?
There was a problem hiding this comment.
Yes, I think extending broadcasts should sit under channels, because it relates to sending emails, SMS etc which are all channels.
|
I've moved all pages from the legacy repo. I have a couple of questions in the comments in the files, and I'd like you to:
TIA! ✨ |
…autic-developer-documentation-new into docs/move-legacy-docs
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
|
Thanks for the approval, @RCheesley! Once it's merged, I'm getting ready for the merge conflicts from the outstanding PRs. 😁 💪🏼 |
|
GTG once we get a 👀 from a dev team member :) |
escopecz
left a comment
There was a problem hiding this comment.
I'm thinking whether we shouldn't drop the outdated docs, but it may help someone. Let's try this
Description
This PR moves legacy docs pages to the new docs with details as follow:
Linked issue
N/A
Screenshots or screen recordings