-
Notifications
You must be signed in to change notification settings - Fork 29
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
Add getting started page to API documentation and add more to the Postman collection #217
Comments
Hello @RCheesley ……Please I’ll like to work on this |
Great @MutiatBash that'd be amazing! Can you start first by adding the getting started page, then we can look at the Postman collections thereafter. Sound good? You can review the content on the PR I linked to under files changed for the getting started page, but please do check it's relevant and up to date with now. |
Hello @RCheesley ...from which branch to which branch do you want me to make the PR to |
Hi @MutiatBash please use the 5.x branch for this one. Thanks! |
Okay....So if i understand clearly, For the first task, i should add the getting started page by raising a PR from "getting-started-and-auth-rest-api" to "5.x branch" @RCheesley .....i see the getting started branch has been deleted |
Can i also get a step by step on how to get started with contributing.......Do i need to fork the repo first, and then create a branch off main. I have been able to install Python and Sphinx |
@RCheesley .....Please i need guidance on setting up |
@favour-chibueze could you do an onboarding with @MutiatBash to get them started with making a PR? Indeed you need to fork the repository and then branch from the 5.x branch, to create your branch for this PR. Then you write the content, commit to your branch, push that branch to your fork, and make the PR back here on this repo. You can see the original content that was written here: https://github.com/mautic/developer-documentation-new/pull/145/files#diff-3e7b5c427c670e5b91bee1d99f4512ef481ae978524e3b347593ce49eae1c809 |
@favour-chibueze @RCheesley .....I keep getting this error after setting up and running "make html" |
@RCheesley .....I have raised a PR for the getting started page...#224 |
We started to use Postman collections in this PR: #145, but for some reason this was never pulled into the current branch. I think we should pull in the getting started page as it has some useful resources.
I'd also love to see us improving the Postman collection for each aspect of the API, to help developers quickly get started with using Mautic's API. Right now we only have list and create contacts.
We can break this down into smaller tasks if needs be, or a group of people can work on it together.
Ping me if you would like to work on this, and I can add you to the collection.
The text was updated successfully, but these errors were encountered: