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

Write documentation on Queue component #67

Open
RCheesley opened this issue Oct 6, 2022 · 7 comments
Open

Write documentation on Queue component #67

RCheesley opened this issue Oct 6, 2022 · 7 comments
Labels
good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed

Comments

@RCheesley
Copy link
Sponsor Member

We need to write documentation on the Queue component.

https://mautic-developer.readthedocs.io/en/latest/components/queue.html

@RCheesley RCheesley added hacktoberfest good first issue Good for newcomers help wanted Extra attention is needed labels Oct 6, 2022
@aanchalsharmaa1024
Copy link

I can do it .assign it to me plz

@RCheesley
Copy link
Sponsor Member Author

Hi @aanchalsharmaa1024 that's great to hear - are you familiar with Mautic and the queuing system?

We have Gitpod so you can spin up the docs environment in the cloud, or work in your local environment with VSCode which should install the necessary extensions to work with Vale/RST.

@aanchalsharmaa1024
Copy link

aanchalsharmaa1024 commented Oct 6, 2022 via email

@RCheesley
Copy link
Sponsor Member Author

OK, it might be quite a big ask for you to take this on if you are completely new to Mautic as there is no documentation right now about it.

You might want to start with an issue like #68 which already has some documentation in the current developer docs, so you would need to just review it against what is currently in Mautic, check that it's still valid, update code examples, improve the documentation where possible, and convert it to RST format.

@dennisameling
Copy link
Member

@RCheesley do you know what section in the old Developer Docs is supposed to be ported over into this section? Or is it something completely new that was added to Mautic 4?

@RCheesley
Copy link
Sponsor Member Author

RCheesley commented Dec 4, 2022 via email

@mautibot
Copy link
Collaborator

This issue has been mentioned on Mautic Forums. There might be relevant details there:

https://forum.mautic.org/t/post-thanksgiving-boost-contribute-to-mautic-this-open-source-friday/30038/1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants