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

social login guide #338

Merged
merged 16 commits into from
Nov 19, 2024
Merged

social login guide #338

merged 16 commits into from
Nov 19, 2024

Conversation

RitaOC
Copy link
Contributor

@RitaOC RitaOC commented Oct 24, 2024

No description provided.

@fakela
Copy link
Member

fakela commented Oct 29, 2024

Hi, @RitaOC good job on this. I have fixed some of the formatting issues myself. @RCheesley or @favour-chibueze will take a look. Thanks 🙏

@RitaOC
Copy link
Contributor Author

RitaOC commented Oct 29, 2024

Hi, @RitaOC good job on this. I have fixed some of the formatting issues myself. @RCheesley or @favour-chibueze will take a look. Thanks 🙏

Thanks so much @fakela, awaiting response from @RCheesley or @favour-chibueze
Issue: #322

@RCheesley
Copy link
Member

@RitaOC please can you follow the instructions for using link macros as below (copied from another issue):

You can build this documentation locally by cloning this repository, and following these steps: https://github.com/mautic/user-documentation/tree/5.x?tab=readme-ov-file#build-documentation-locally. Change into the /docs folder and then (assuming you have DDEV and Docker/Colima installed) type ddev config and select build/html as the root folder when configuring DDEV. Then when complete, type ddev start and it'll give you the link to your local testing environment.

If you need to make a link file to add an external URL, please use the command line tool 'make link'. This will generate a reference macro and a link file for you.

For internal linking check the docs on using the :ref: role for linking within the same document, and using :doc: to link across pages.

Please also use the following header syntax:

H1 ###
H2 ***
H3 ===
H4 ---
H5 ~~~

I've marked it as accepted due to the deadline but these need addressing before we can consider it for merging.

@RitaOC
Copy link
Contributor Author

RitaOC commented Nov 1, 2024

Thanks so much @RCheesley, I've worked on it.
Please take a look at it again.

Copy link
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @RitaOC thanks for making this PR!

There are a lot of things that you missed because Vale was turned off right at the start, and turned on right at the end ... that's cheating! 🤣

I've suggested fixes for all the incorrect nested headings, and also for many of the Vale issues that were reported. Please take a look and address as you see fit.

Thanks!

docs/plugins/social_login.rst Outdated Show resolved Hide resolved
docs/plugins/social_login.rst Outdated Show resolved Hide resolved
docs/plugins/social_login.rst Outdated Show resolved Hide resolved
docs/plugins/social_login.rst Outdated Show resolved Hide resolved
docs/plugins/social_login.rst Outdated Show resolved Hide resolved
docs/plugins/social_login.rst Outdated Show resolved Hide resolved
docs/plugins/social_login.rst Outdated Show resolved Hide resolved
docs/plugins/social_login.rst Outdated Show resolved Hide resolved
docs/plugins/social_login.rst Outdated Show resolved Hide resolved
docs/plugins/social_login.rst Outdated Show resolved Hide resolved
@RitaOC
Copy link
Contributor Author

RitaOC commented Nov 3, 2024

Ohh I actually met the Vale written as such in the document, never knew it was wrong but I'd be sure to remove the both lines that speaks to that, I'd also work on all other issues raised and revert back. Thanks for your patience @RCheesley

To sort the vale removal, heading and formatting issues

Co-authored-by: Ruth Cheesley <[email protected]>
To sort vale removal & heading issue

Co-authored-by: Ruth Cheesley <[email protected]>
@RitaOC
Copy link
Contributor Author

RitaOC commented Nov 4, 2024

Hi @RCheesley, I've resolved all the issues raised, kindly go through it.
Thank you.

Copy link
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is good to go - the build failure is due to Maxmind blocking the agent that checks the links (we will need a PR to add it to the ignored URLs for the checker) and the warnings are not needing to be addressed as the words are being used in a different context.

Thanks for the hard work @RitaOC 🚀

@RCheesley RCheesley merged commit 487f19b into mautic:5.x Nov 19, 2024
1 of 2 checks passed
@RitaOC
Copy link
Contributor Author

RitaOC commented Nov 19, 2024

Thanks so much for your direction on this, glad I could wrap it up till the end.

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.

3 participants