aws-amplify / aws-amplify/docs

Monorepo documentation is incomplete/unclear

Open
#7,781 7 comments 2 reactions 0 assignees View on GitHub
amplify/backend amplify/hosting
Dominant language
MDX
Stars
506
Forks
1.1k
Avg merge
3h 14m
Merged PRs (30d)
1

Description

**Describe the content issue**:

I'm using NX for my monorepo and am following the instructions https://docs.amplify.aws/nextjs/deploy-and-host/fullstack-branching/monorepos/

I found that if I follow the following steps to setup the monorepo, the Amplify Console will incorrectly detect the framework of the backend project and actually not identify the backend project is an Amplify project.

Create the monorepo (npx nx create-nx-workspace --preset=next)
cd to the monorepo folder and npm create amplify@latest in /packages/backend
Go to Amplify console and select packages/backend as the monorepo folder for the backend app. In this case, you'll see that the console will not understand this to be amplify Gen 2 but, will detect next.js as the framework
The console correctly identifies the framework as Amplify Gen 2 if I follow the following steps:

Create the nx workspace in a subfolder of the repo (say, "myworkspace")
Create the Amplify inside the subfolder.
Set myworkspace/packages/backend as monorepo root for backend app. In this case, everything works fine.

What is causing this to happen? How can we get the framework to be identified correctly?

**URL page where content issue is**:
https://docs.amplify.aws/nextjs/deploy-and-host/fullstack-branching/monorepos/

Contributor guide

Open the contributing guide

Research direction

Start with the monorepo guidance at https://docs.amplify.aws/nextjs/deploy-and-host/fullstack-branching/monorepos/ and reproduce the two NX workspace layouts described in the issue. Compare how the Amplify Console detects each backend path, then update the page to explain the cause and the setup that correctly identifies Amplify Gen 2.

Written by the indexing model from the issue text.

Assessment

Tech stack
next.js
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.