This is the documentation project for the PWA Studio documentation site. It is a Gatsby project built using the Adobe I/O Gatsby Theme.
For local development, run the following commands:
npm install
npm run dev
PWA Studio Docs
Home Page: https://developer.adobe.com/commerce/pwa-studio/
License: Apache License 2.0
This is the documentation project for the PWA Studio documentation site. It is a Gatsby project built using the Adobe I/O Gatsby Theme.
For local development, run the following commands:
npm install
npm run dev
Issue in /src/pages/guides/packages/venia/sample-data/index.md
I tried following the docs above, but it throws a message when I do step 3
git clone [email protected]:magento/venia-sample-data-modules.git ext/magento/venia-sample-data-modules
Issue:
ERROR: Repository not found.
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.
Following this link: https://developer.adobe.com/commerce/pwa-studio/guides/packages/venia/sample-data/
Issue in /src/pages/tutorials/basic-modifications/enable-sass-less/index.md
While trying to enable SASS support in a magento PWA studio project, I have experienced the following issues:
node-sass
package is deprecated, I've used sass
package insteadsass-loader
package require webpack > 5
in newer versions; if magento pwa studio project use webpack 4.x, I've use sass-loader@10
packagelocalIdentName
option is not supported in webpack.config.js
To summarize, in order to enable SASS support we need to:
yarn add --dev sass sass-loader@10
webpack.config.js
config.module.rules.push({
test: /\.s[ca]ss$/,
use: [
'style-loader',
{
loader: 'css-loader',
options: {
modules: true,
sourceMap: true,
}
},
'sass-loader'
]
});
I think it could be useful to report this information in the documentation.
Issue in /src/pages/tutorials/basic-modifications/enable-sass-less/index.md
Issue in injected react component, with .scss file imported and used.
The component is very simple. I've only styled a piece of text.
and the configuration that I added to webpack.config.js is:
config.module.rules.push({
test: /\.s[ac]ss$/,
use: [
// Creates `style` nodes from JS strings
"style-loader",
// Translates CSS into CommonJS
{
loader: 'css-loader',
options : {
modules : true,
sourceMap : true,
localIdentName : '[name]-[local]-[hash:base64:3]'
}
},
// Compiles Sass to CSS
"sass-loader",
],
})
And the error I see in my browser console is:
/src/components/Redirecting/redirecting.scss (./node_modules/css-loader/dist/cjs.js??ref--8-1!./node_modules/sass-loader/dist/cjs.js!./src/components/Redirecting/redirecting.scss)
Module build failed (from ./node_modules/sass-loader/dist/cjs.js):
TypeError: this.getOptions is not a function
at Object.loader (/home/me/my-app-folder/node_modules/sass-loader/dist/index.js:27:24)
Note : Going to https://webpack.js.org/loaders/sass-loader/, node-sass was marked as depracted, so I used the updated library: dart sass, however, I already had tried with node-sass and saw the same error.
Using the configuration suggested in this address, nothing changed, since it's not that different either:
module.exports = {
module: {
rules: [
{
test: /\.s[ac]ss$/i,
use: [
// Creates `style` nodes from JS strings
"style-loader",
// Translates CSS into CommonJS
"css-loader",
// Compiles Sass to CSS
"sass-loader",
],
},
],
},
};
Issue in /src/pages/tutorials/setup-storefront/issues/index.md
The link "Basic modifications" at the end of the page pointing to the next section is broken.
Issue in /src/pages/metapackages/open-source/index.md
The extension name is magento/pwa
and not magento/magento2-pwa
. Please fix this in the section "Cloud deployment extension installation"
Issue in /src/pages/integrations/index.md
The Integration page has a broken link to "Magento" at the bottom of the page. You should probably change "Magento" to "Adobe Commerce" in the left nav as well.
Issue in /src/pages/tutorials/setup-storefront/file-structure/index.md
The link to "Modular Components" leads to a 404. Modular components
You can find it here https://developer.adobe.com/commerce/pwa-studio/tutorials/setup-storefront/file-structure/#driversjs
Issue in /src/pages/tutorials/targets/modify-talon-results/index.md
The link "talons target" at the beginning of the first paragraph is broken.
Issue in /src/pages/tutorials/basic-modifications/modify-footer/index.md
Visit this URL: https://developer.adobe.com/commerce/pwa-studio/metapackages/venia-sample-data/
Check the below installation step 3.
3. Clone the venia-sample-data-modules repository into your vendor directory within ext:
git clone [email protected]:magento/venia-sample-data-modules.git ext/magento/venia-sample-data-modules
I am not able to clone that repo. The above git command should work.
git clone [email protected]:magento/venia-sample-data-modules.git ext/magento/venia-sample-data-modules
The above git command is not working. it gives the below error.
ERROR: Repository not found.
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
git clone [email protected]:magento/venia-sample-data-modules.git ext/magento/venia-sample-data-modules
The above git command should work.
No response
No response
I think that this version of documentation is deprecated and a new one should be created for version 2.4.4
Issue in /src/pages/integrations/pagebuilder/custom-components/index.md
When we read this page TargetableReactComponent, in the detail section of each method, it doesn't show method name
It should show method name like this(left on image)
I saw there is a commit that removed method names: #67
Getting error while setting up pwa studio. I believe this is because the graphql url returns some error.
https://venia-develop-**********************magentosite.cloud/graphql/ returns below error.
"An error has happened during application run. See exception log for details.
Could not write error message to log. Please use developer mode to see the message."
Because of the above issue yarn watch throws invalid json error.
Please help how to resolve this
While making some changes to the Metapackage instructions I was informed that as of M2.4.7-beta, the meta package code (GraphQLPwa and GraphQlAux) modules are going to be bundled into the core Magento repository.
If this is definitely happening, it would be good to have an info box at the head of each of the metapackage pages that alerts those reading it, so that they can prepare.
Other places to consider some messaging:
Metapackage (Deprecated)
If that is the case we just need to determine the right copy for the message and do it. I'm more than happy to donate my time to do that once we've landed on the correct wording.
cc @keharper (originally informed me on this)
An example could be using the BlockQuote function in MD:
Like so
<<< END_OF_EXAMPLE
ⓘ This metapackage is currently separately required in each Magento backend the PWA is configured for, but will be bundled into the Core Magento codebase as of Magento 2.4.7
END_OF_EXAMPLE
Issue in /src/pages/tutorials/basic-modifications/modify-footer/index.md
Clicking on Next chapter link in right bottom cat shows 404 page..
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.