Questions tagged [documentation]
The documentation tag has no usage guidance.
35
questions
0
votes
2
answers
130
views
Indentation Style (Code style) Magento 2
Hey, I wanna check if there is some documentation about the code style for magento, specially regarding the best practices Indentation style for magento.
I will give 2 examples, and I wanna also know ...
0
votes
1
answer
78
views
Magento 2.1.10 ce Developer Documentation
Where can I find the Developer Documentation for an older version of Magento, specifically, version 2.1.10.
Magento's website only has the DeVDocs for 2.2 and while these are okay I would they aren't ...
- 41
2
votes
1
answer
490
views
Is there any documentation tool available for GraphQl?
I need to document both Magento2 in-built and custom GraphQl endpoints. (Just like we use swagger to document APIs). So far I tried the below tools. But both seem to be covering a limited number of ...
- 9,935
0
votes
1
answer
342
views
Where can I find the full syntax specification for Markup Tags (double curly braces)?
I have found some documentation for Magento's Markup Tags, but nothing that would appear to be complete. For search-ability, I've also seen them described as "double curly brace syntax", &...
- 3
1
vote
1
answer
683
views
Magento 2.4 dev.docs: about recommended Elasticsearch configurations
There are two different recommendations/examples:
"The Magento application and Elasticsearch are installed on different hosts (Running on separate hosts is secure, enables Elasticsearch to be ...
- 13
0
votes
1
answer
205
views
setup:static-content:deploy -f (Documentation)
Please I did not understand this in documentation.
Running this command with the -f argument can fix issues regarding deployment of static content, but removes all symlinks and deploys the actual ...
- 113
0
votes
0
answers
30
views
Where can I find a list of features in Magento along with explanations?
For example, this link: https://info2.magento.com/rs/magentosoftware/images/magento-feature-list.pdf - has a great list of features, but without any explanation of what that feature is about.
For ...
- 101
0
votes
1
answer
24
views
Where is the source of the following text inside the documentation?
On the DevDocs https://devdocs.magento.com/guides/v2.3/frontend-dev-guide/css-topics/using-fonts.html Link, there is the following text bellow the mixin example:
@font-display: swap is declared by ...
- 113
6
votes
1
answer
279
views
Where can I find official documentation of the internal functions and methods used by Magento's default/core modules?
Am I missing something or does Magento not provide any documentation about the core/default modules it uses?
Let's use an example: say I want to create a module which incorporates various core ...
- 1,178
2
votes
3
answers
5k
views
Where is the Magento 1.9 developer documentation?
The only good/bonafide documentation I can find is here:
https://devdocs.magento.com/guides/m1x/magefordev/mage-for-dev-1.html
but in that documentation, it even states that there's much more to learn....
- 193
1
vote
1
answer
44
views
Are Magento Object propertyNames that are prefixed by "_" different from ones that aren't?
what does this tell me ? Is there a place in the devdoc's I wasn't able to find or is this a convention I don't know about?
thanx for your help...
0
votes
1
answer
33
views
Are there any Magento Code Release Notes?
I have been looking for some kind of code release notes. I have browsed through the released notes information and through all the versions trying to find any kind of clear statement where they say ...
- 790
2
votes
1
answer
315
views
Online Customers --> How is this checked?
So,
In this doc:
Online Customers
It is explained how Magento 2 checks if customers are online and how to set the interval to check this.
BUT
What is not so clear, is how Magento 2 does this. ...
- 637
0
votes
2
answers
123
views
Magento 2 : How to write a custom extension? [closed]
There is already a question on how to write a custom extension at How to write a custom extension? , but most of the answers I read , while being good and really detailed are about magento 1, so felt ...
- 4,975
0
votes
1
answer
69
views
Magento 2 - documentation library for modules
I am big fan of Java developer docs - http://devdocs.io/haxe~java/lang/abstractstringbuilder#codePointBefore ., I dont find similar one for magento 2. Can anyone share the link if you have a know how?
0
votes
1
answer
24
views
Magento2 Documentation Suggestions or Issue Raising
Is there any way to make Suggestions or Raise Issues regarding the official Magento 2 docs?
If so where and how is the best way to go about it?
- 3,480
1
vote
1
answer
355
views
How to find valid values for fields in the REST API
I have been searching for documentation regarding the REST API.
All I have found is the Swagger page. It gives a good overview but it doesn't provide any information about valid values for ...
2
votes
2
answers
892
views
Generate images for performance testing
Looking at the official Magento 2 dev docs on the subject of generating data for performance testing, the example image suggests that product images are generated in the process.
I ran the exact ...
- 21
2
votes
1
answer
2k
views
Magento 1.9 Where to get a full list of all magento functions / methods and their explanations [duplicate]
where to find a complete list of all Magento functions and methods and the explanation of them?
- 2,014
1
vote
0
answers
406
views
Magento 2 xml/csv convert
I am trying to figure out how that an automatic feed (csv or xml) works within Magento 2. Does anyone know a page with information on how to do so?
I have the xml product feed or the CSV product ...
- 2,447
0
votes
1
answer
221
views
How I can see the native intern Magento 2 UI library?
I run the grunt documentation but I can't be able to see the docs, I saw a 404 page, why?
http://dev.local/redstore/lib/web/css/docs/index.html
1
vote
2
answers
513
views
Remove checkbox label
Is there a way to remove a checkbox label from above?
I looked into documentation, but i didn't find any similar example.
- 85
2
votes
1
answer
67
views
is there an official doc planning how to create a module
I've spent several hours reading magento 2's official documentation, and I haven't found how to create a module :
The documentation explain the structure of the filesystem, list the files that we can ...
- 123
1
vote
1
answer
272
views
Magento 2: Guide for All Collections
For now, I'm not able to find any guide for this. If I need to get all collection say for Example all Orders List
so I will go to Vendor Magento Folder, Particular Module's di.xml file & checking ...
- 9,849
2
votes
2
answers
827
views
Magento 2 API Reference [duplicate]
I cannot find an (official or not) API reference for Magento 2.
/!\ I'm not looking for the reference of the REST API (http://devdocs.magento.com/swagger/index.html) or SOAP API, but I'm looking for ...
- 387
0
votes
1
answer
228
views
Magento Block classes and docs
I've been using Magento 2 to do some theme development and I'm wracking my brain trying to find documentation for block classes. I've been digging through Block folders and stuff. I'm wondering if ...
- 3
4
votes
1
answer
325
views
Reference for Magento2 best practices
First of all this might not be the right place to ask this question, if this is the case please let me know where the right place is?
Currently there is the module best practice reference on http://...
- 1,105
1
vote
0
answers
26
views
Insert in admin critical documentation for my module
My module has an import CSV functionality and I would like to explain in ~10 lines how that csv should be formatted, max size etc.
I am using ui components.
There is this <item name="notice" xsi:...
- 6,227
4
votes
2
answers
850
views
Is there a Magento v.1.x developer reference like is Codex for WordPress?
Is there something like https://developer.wordpress.org/reference/ (Code Reference) for Magento CE v.1.x like this is for WordPress?
- 209
3
votes
2
answers
1k
views
Is there a Magento API reference?
Is there an API reference or documentation for Magento that I can refer to find out the methods available in the different Mage classes?
Let's say I want to find out more about the method ...
- 875
4
votes
1
answer
662
views
Where can I find documentation on the Varien Javascript library?
Magento ships with a number Varien javascript libraries (located under js/varien) which it uses for clientside features such as form validation.
Where can I find an API guide for this, or high level ...
- 2,047
3
votes
1
answer
54
views
Where on earth is the wiki?
I had dozens of informtive links bookmarked.. Now they're all gone.
For example
https://www.magentocommerce.com/wiki/1_-_installation_and_configuration/using_collections_in_magento
Now all it does ...
- 794
4
votes
1
answer
159
views
Magento 1 PHPDoc syntax incorrect?
I've noticed the following style PHPDoc declarations in Magento core code, and subsequently copied in Magento extensions:
/** @var $varName Mage_Core_Model_Example */
Should it not follow the @var [...
- 2,014
5
votes
1
answer
953
views
Does a complete "config.xml" reference exist?
I am in the process of writing some in-house documentation that goes a bit beyond the "hello world" examples that populate the internet and would like to start a complete reference wiki on some of the ...
- 442
30
votes
2
answers
5k
views
Why are so many PHP functions disallowed in the Magento ECG Coding Standard?
The Magento ECG Coding Standard seems to be (at least kind of) official as standard for Magento 1 extensions:
https://github.com/magento-ecg/coding-standard
But I don't understand the reasoning ...
- 65.7k