loginradius/docs

LoginRadius Developer Documentation

docs's Issues

Fix Eslint Error in menu-item.js

warn message show in console

  39:12  warning  Anchors must have content and the content must be accessible by a screen reader                 jsx-a11y/anchor-has-content
  39:12  warning  Visible, non-interactive elements with click handlers must have at least one keyboard listener
jsx-a11y/click-events-have-key-events
  39:12  warning  Static HTML elements with event handlers require a role
jsx-a11y/no-static-element-interactions

Integration doc - LoginRadius with Cosmos DB

• Prepare integration document on how to integrate Cosmos DB with LoginRadius
• You will need to create an account here - https://accounts.loginradius.com/auth.aspx?return_url=https://dashboard.loginradius.com/login&action=register
• Go to the integration section to explore
• Reference for template - https://www.loginradius.com/docs/developer/guide/shopify/
• Document should be end to end I.e. what all needs to be done in LoginRadius and Cosmos DB

List out API Error Messages with description

• Get APIs here https://www.loginradius.com/docs/developer/#api
• List out API Error Messages with description in a doc

Enhancing Pull Request Template

I want to enhance the Pull Request template, by adding more features and information along with the terms and conditions checklist. Please assign this issue to me.

Add GitHub issue forms

Is your feature request related to a problem? Please describe.

GitHub has recently rolled out a public beta for their issue forms feature. This would allow you to create interactive issue templates and validate them 🤯.

Describe the solution you'd like

This repository currently uses no issue template. Your task is to create GitHub issue forms for this repository. We can use standard issue templates as a reference for this PR.

Tool/script to make sure that external links (not part of the same doc) open in new tab

• A tool/script that you can run to confirm if links external to the docs are opening in a new tab or not.
• Should generate log or something as a result that can be referred to.

Integration doc - LoginRadius with MySQL

• Prepare integration document on how to integrate MySQL with LoginRadius
• You will need to create an account here - https://accounts.loginradius.com/auth.aspx?return_url=https://dashboard.loginradius.com/login&action=register
• Go to the integration section to explore
• Reference for template - https://www.loginradius.com/docs/developer/guide/shopify/
• Document should be end to end I.e. what all needs to be done in LoginRadius and MySQL

Pull request template includes broken link.

The pull request template has a broken link which is supposed to redirect to CONTRIBUTING.md.

Integration doc - LoginRadius with Salesforce Pardot

• Prepare integration document on how to integrate Salesforce Pardot with LoginRadius
• You will need to create an account here - https://accounts.loginradius.com/auth.aspx?return_url=https://dashboard.loginradius.com/login&action=register
• Go to the integration section to explore
• Reference for template - https://www.loginradius.com/docs/developer/guide/shopify/
• Document should be end to end I.e. what all needs to be done in LoginRadius and Salesforce Pardot

Doc - Inbound SSO - OAuth2 with LoginRadius

• Prepare integration document on how to integrate Inbound SSO - OAuth2 with LoginRadius
• You will need to create an account here - https://accounts.loginradius.com/auth.aspx?return_url=https://dashboard.loginradius.com/login&action=register
• Go to the integration section to explore
• Reference for template - https://www.loginradius.com/docs/developer/guide/shopify/
• Document should be end to end I.e. what all needs to be done in LoginRadius and Inbound SSO - OAuth2

Link CONTRIBUTING.md to README.md

So that it will easier for contributors to find it on README.md

Tutorial: Implementing authentication using LoginRadius React SDK in Gatsby JS Application

• Need to add the tutorial under /content/tutorial/gatsbyjs, folder.
• This tutorial should utilize the LoginRadius React SDK for the implementation.
• For your reference, we already have an gatsbyjs example in the LoginRadius React SDK repo, you can check it out here.
• Document should be an end to end I.e. what all needs to be done in LoginRadius GatsbyJS Tutorial

Integration doc - LoginRadius with MongoDB

• Prepare integration document on how to integrate MongoDB with LoginRadius
• You will need to create an account here - https://accounts.loginradius.com/auth.aspx?return_url=https://dashboard.loginradius.com/login&action=register
• Go to the integration section to explore
• Reference for template - https://www.loginradius.com/docs/developer/guide/shopify/
• Document should be end to end I.e. what all needs to be done in LoginRadius and MongoDB

Support for detailed table of content on right sidebar by including h3 tag as heading

Support for detailed table of content on right sidebar by including h3 tag as heading

Eslint Error in search.js

May be we should fix this as well?

/docs/src/gatsby-theme-apollo-docs/components/search.js
  85:9  warning  onMouseOver must be accompanied by onFocus for accessibility  jsx-a11y/mouse-events-have-key-events

✖ 1 problem (0 errors, 1 warning)

Create fragment URL for `Ready To Start Building` section on https://www.loginradius.com/docs/developer/

• When used, this fragment URL should land user to Ready To Start Building section
• Fragment URL should look like: https://www.loginradius.com/docs/developer/#getstarted
• Fragment URL Reference that exists for API section- https://www.loginradius.com/docs/developer/#api

Security: High Risk Vulnerabilities in current npm packages

On local installation of the project, npm had reported 1751 vulnerabilities:

• 8 High
• 2 Moderate
• 1741 Low

On running npm audit fix, it fixed 1746 of them however 5 of them need to be manually reviewed.

These vulnerabilities could lead to Remote Memory Exposure, Signature Malleability, Prototype Pollution, Regular Expression Denial of Service

Integration doc - LoginRadius with Microsoft Power BI

• Prepare integration document on how to integrate Microsoft Power BI with LoginRadius
• You will need to create an account here - https://accounts.loginradius.com/auth.aspx?return_url=https://dashboard.loginradius.com/login&action=register
  Go to the integration section to explore
  Reference for template - https://www.loginradius.com/docs/developer/guide/shopify/
  Document should be end to end I.e. what all needs to be done in LoginRadius and Microsoft Power BI

Fix typo in docs

Integration doc - LoginRadius with PostgreSQL

• Prepare integration document on how to integrate PostgreSQL with LoginRadius
• You will need to create an account here - https://accounts.loginradius.com/auth.aspx?return_url=https://dashboard.loginradius.com/login&action=register
• Go to the integration section to explore
• Reference for template - https://www.loginradius.com/docs/developer/guide/shopify/
• Document should be end to end I.e. what all needs to be done in LoginRadius and PostgreSQL

Docker support

Suggestion to add docker file in order to provide another way of app access.

Add copy button to code snippets

• Add a copy button at the top right in the code snippets.
• Clicking the Copy button should copy the code of the respective snippet.
• When copied, the copy button text should change to Copied for a brief movement and then back to Copy.

vscode not included in .gitignore file

vscode files should be added in gitignore file

Integration doc - LoginRadius with WordPress

• Prepare integration document on how to integrate WordPress with LoginRadius
• You will need to create an account here - https://accounts.loginradius.com/auth.aspx?return_url=https://dashboard.loginradius.com/login&action=register
• Go to the integration section to explore
• Reference for template - https://www.loginradius.com/docs/developer/guide/shopify/
• Document should be end to end I.e. what all needs to be done in LoginRadius and WordPress