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

Integration documentation #7282

Merged
merged 22 commits into from
Aug 17, 2020
Merged

Conversation

Mcastres
Copy link
Contributor

Description of what you did:

  • Added an Integration subcategory in the Content API that contains links to React Integration
  • Added Links to React Integration at the end of the Getting Started experience

alexandrebodin and others added 10 commits July 25, 2020 08:41
Signed-off-by: Alexandre Bodin <bodin.alex@gmail.com>
Bumps [koa-session](https://github.com/koajs/session) from 5.13.1 to 6.0.0.
- [Release notes](https://github.com/koajs/session/releases)
- [Changelog](https://github.com/koajs/session/blob/master/History.md)
- [Commits](koajs/session@5.13.1...6.0.0)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
fix regression issue due to pull #7204

Signed-off-by: Akash P <aksdevac@gmail.com>
@Mcastres
Copy link
Contributor Author

Please review the architecture of the Integrations.

  • Integration page in Content API that contains all integration links
  • All integrations link at the end of the Getting Starter

@codecov
Copy link

codecov bot commented Jul 31, 2020

Codecov Report

Merging #7282 into documentation will increase coverage by 7.03%.
The diff coverage is n/a.

Impacted file tree graph

@@                Coverage Diff                @@
##           documentation    #7282      +/-   ##
=================================================
+ Coverage          19.14%   26.17%   +7.03%     
=================================================
  Files                855     1130     +275     
  Lines              11933    15414    +3481     
  Branches            1898     2439     +541     
=================================================
+ Hits                2284     4034    +1750     
- Misses              8100     9561    +1461     
- Partials            1549     1819     +270     
Flag Coverage Δ
#front 18.27% <ø> (+3.78%) ⬆️
#unit 52.96% <ø> (+13.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
packages/strapi-plugin-email/admin/src/pluginId.js 0.00% <0.00%> (-100.00%) ⬇️
...n/src/containers/NotificationProvider/constants.js 0.00% <0.00%> (-100.00%) ⬇️
...i-admin/admin/src/containers/SettingsPage/index.js 0.00% <0.00%> (-66.67%) ⬇️
...trapi-admin/admin/src/containers/LeftMenu/index.js 5.00% <0.00%> (-61.67%) ⬇️
...n/admin/src/containers/LanguageProvider/reducer.js 0.00% <0.00%> (-61.54%) ⬇️
...in/admin/src/containers/Webhooks/ListView/index.js 0.00% <0.00%> (-42.11%) ⬇️
...in/admin/src/containers/Webhooks/EditView/index.js 0.00% <0.00%> (-38.40%) ⬇️
packages/strapi/lib/services/metrics/index.js 65.00% <0.00%> (-35.00%) ⬇️
...admin/admin/src/components/ContainerFluid/index.js 66.66% <0.00%> (-33.34%) ⬇️
...s/strapi-admin/admin/src/containers/Admin/index.js 63.82% <0.00%> (-15.66%) ⬇️
... and 645 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cba02fe...d68a69f. Read the comment docs.

@derrickmehaffy
Copy link
Member

derrickmehaffy commented Jul 31, 2020

@lauriejim I'm wondering if it would be better to offload all the svgs to files and import them (just to keep the inline html cleaner and easier to read)

(for all of them not just here)

@lauriejim
Copy link
Contributor

Good for the structure 👍

Copy link
Member

@derrickmehaffy derrickmehaffy left a comment

Choose a reason for hiding this comment

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

Great initial start, just a few small things I noticed.

Something else we should look at is give a bit more describing text and not just code samples. It will probably also be worth diving deeper into more of the content API topics relating to other types of requests (PUT, POST, DELETE) and query parameters and filtering.

docs/v3.x/content-api/integrations.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/quick-start.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/react.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/react.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/react.md Show resolved Hide resolved
docs/v3.x/getting-started/react.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/react.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/react.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/react.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/react.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/react.md Show resolved Hide resolved
docs/v3.x/getting-started/react.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/react.md Outdated Show resolved Hide resolved
@Mcastres
Copy link
Contributor Author

Mcastres commented Aug 4, 2020

Made some modifications @derrickmehaffy @soupette

@derrickmehaffy derrickmehaffy self-requested a review August 4, 2020 14:43
Copy link
Member

@derrickmehaffy derrickmehaffy left a comment

Choose a reason for hiding this comment

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

Looking very nice @Mcastres 👍

docs/v3.x/content-api/integrations.md Show resolved Hide resolved
docs/v3.x/getting-started/react.md Show resolved Hide resolved
docs/v3.x/getting-started/react.md Show resolved Hide resolved
docs/v3.x/getting-started/react.md Show resolved Hide resolved
docs/v3.x/getting-started/react.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/react.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/react.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/react.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/react.md Show resolved Hide resolved
docs/v3.x/getting-started/react.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/next-js.md Show resolved Hide resolved
docs/v3.x/getting-started/next-js.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/next-js.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/next-js.md Show resolved Hide resolved
docs/v3.x/getting-started/next-js.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/next-js.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/nuxt-js.md Show resolved Hide resolved
docs/v3.x/getting-started/nuxt-js.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/nuxt-js.md Show resolved Hide resolved
docs/v3.x/getting-started/nuxt-js.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/nuxt-js.md Show resolved Hide resolved
docs/v3.x/getting-started/react.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/vue-js.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/vue-js.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/vue-js.md Outdated Show resolved Hide resolved
@derrickmehaffy derrickmehaffy changed the title Docs/integrations/react Integration documentation Aug 10, 2020
docs/v3.x/getting-started/nuxt-js.md Show resolved Hide resolved
docs/v3.x/getting-started/nuxt-js.md Show resolved Hide resolved
docs/v3.x/getting-started/nuxt-js.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/react.md Show resolved Hide resolved
docs/v3.x/getting-started/react.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/react.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/nuxt-js.md Outdated Show resolved Hide resolved
docs/v3.x/getting-started/nuxt-js.md Outdated Show resolved Hide resolved
Copy link
Contributor

@soupette soupette left a comment

Choose a reason for hiding this comment

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

LGTM

@Mcastres
Copy link
Contributor Author

When do you think this PR can be merged? @lauriejim?

@derrickmehaffy
Copy link
Member

When do you think this PR can be merged? @lauriejim?

Give me another day @Mcastres to review how it looks locally and I'll redo my review (just want to review the english grammar as well to make sure we don't miss anything

@derrickmehaffy derrickmehaffy self-requested a review August 12, 2020 16:49
@lauriejim lauriejim added source: docs Documentation changes issue: enhancement Issue suggesting an enhancement to an existing feature labels Aug 16, 2020
Copy link
Contributor

@lauriejim lauriejim left a comment

Choose a reason for hiding this comment

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

LGTM
@Mcastres let me know when you are ready for a merge et deploy.

@derrickmehaffy
Copy link
Member

This looks good to me (sorry forgot to respond) very well done @Mcastres

@Mcastres
Copy link
Contributor Author

You can merge @lauriejim

@derrickmehaffy derrickmehaffy merged commit 28f1d6d into documentation Aug 17, 2020
@lauriejim lauriejim deleted the docs/integrations/react branch August 18, 2020 08:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
issue: enhancement Issue suggesting an enhancement to an existing feature source: docs Documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants