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

Add getting started page to API documentation and add more to the Postman collection #217

Open
2 tasks
RCheesley opened this issue Sep 25, 2024 · 10 comments
Open
2 tasks
Assignees
Labels
hacktoberfest help wanted Extra attention is needed

Comments

@RCheesley
Copy link
Member

RCheesley commented Sep 25, 2024

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.

  • Make a PR for the getting started page @MutiatBash
  • Add more to the collection on Postman

Ping me if you would like to work on this, and I can add you to the collection.

@MutiatBash
Copy link

Hello @RCheesley ……Please I’ll like to work on this

@RCheesley
Copy link
Member Author

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.

@RCheesley RCheesley moved this from Ready to In progress in Mautic's 2024 No/Low/Code Tasks Oct 8, 2024
@MutiatBash
Copy link

Hello @RCheesley ...from which branch to which branch do you want me to make the PR to

@RCheesley
Copy link
Member Author

Hi @MutiatBash please use the 5.x branch for this one. Thanks!

@MutiatBash
Copy link

MutiatBash commented Oct 10, 2024

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

@MutiatBash
Copy link

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

@MutiatBash
Copy link

@RCheesley .....Please i need guidance on setting up

@RCheesley
Copy link
Member Author

@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

@MutiatBash
Copy link

@favour-chibueze @RCheesley .....I keep getting this error after setting up and running "make html"
Image

@MutiatBash
Copy link

@RCheesley .....I have raised a PR for the getting started page...#224

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest help wanted Extra attention is needed
Projects
Status: In progress
Development

No branches or pull requests

2 participants