Update FAQ section in the docs. #3011

mtias · 2017-10-12T15:17:19Z

Revising the FAQ document.

codecov · 2017-10-12T15:24:42Z

Codecov Report

Merging #3011 into master will increase coverage by 0.43%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #3011      +/-   ##
==========================================
+ Coverage   34.37%   34.81%   +0.43%     
==========================================
  Files         196      208      +12     
  Lines        5809     6738     +929     
  Branches     1027     1250     +223     
==========================================
+ Hits         1997     2346     +349     
- Misses       3222     3678     +456     
- Partials      590      714     +124

Impacted Files	Coverage Δ
components/dropdown/index.js	`78.57% <0%> (-8.93%)`	⬇️
editor/header/publish-button/index.js	`83.33% <0%> (-5.13%)`	⬇️
blocks/library/html/index.js	`19.04% <0%> (-4.03%)`	⬇️
editor/modes/visual-editor/inserter.js	`90% <0%> (-3.34%)`	⬇️
blocks/library/latest-posts/index.js	`7.22% <0%> (-2.78%)`	⬇️
blocks/library/button/index.js	`18.18% <0%> (-1.82%)`	⬇️
blocks/library/gallery/block.js	`9.75% <0%> (-1.36%)`	⬇️
editor/utils/dom.js	`39.53% <0%> (-0.95%)`	⬇️
components/dropdown-menu/index.js	`94.17% <0%> (-0.62%)`	⬇️
blocks/library/table/table-block.js	`7.4% <0%> (-0.6%)`	⬇️
... and 40 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 63cb942...d389a99. Read the comment docs.

aduth · 2017-10-13T17:28:43Z

docs/faq.md

+
+Our goal with Gutenberg is not just to create a seamless post- and page-building experience. We also want to ensure that it provides a seamless writing experience. Though individual paragraphs of text will become their own “blocks,” the creation and editing of these blocks are being designed in a way that could be just as simple—if not more so—than the current WordPress editor experience. Here is a brief animation illustrating the Gutenberg writing experience:
+
+https://make.wordpress.org/core/files/2017/08/typing.gif


Was this image meant to be embedded? Should be ![alt](url) syntax if so.

aduth · 2017-10-13T17:29:32Z

docs/faq.md


-## Does Gutenberg involve editing posts/pages in the frontend?
-No, Gutenberg is a replacement for the post and page editing screens.
+The API for creating blocks is a crucial aspect of the project. We are working on improved documentation and tutorials. Current documentation lives here


Where is "here"?

aduth · 2017-10-13T17:30:53Z

docs/faq.md

+
+## Does Gutenberg involve editing posts/pages in the front-end?
+
+No, we are designing Gutenberg primarily as a replacement for the post and page editing screens. That said, front-end editing is often confused with an editor that looks exactly like the front end. And that is something that Gutenberg will allow as themes customize individual blocks and provide those styles to the editor. Since content is designed to be distributed across so many different experiences—from desktop and mobile to full-text feeds and syndicated article platforms—we believe it's not ideal to create or design posts from just one front-end experience.


Do we care to make any mention of editor as a set of reusable pieces that someone could potentially use in a front-end context the way they might be envisioning?

aduth · 2017-10-13T17:31:31Z

docs/faq.md


 ## Given Gutenberg is built in JavaScript, how will old metaboxes (PHP) work?
-We expect to have a dedicated "advanced" area at the bottom of the editor. It’s not yet implemented, we are tracking it here: https://github.com/WordPress/gutenberg/issues/952
+
+We expect to have a dedicated "advanced" area at the bottom of the editor. It’s not yet implemented, and we are tracking development here: https://github.com/WordPress/gutenberg/issues/952


Have we made a decision about "bottom" ? Specifically thinking about meta boxes in sidebar, etc. May be worth omitting altogether at this point.

aduth · 2017-10-13T17:33:13Z

docs/faq.md


 ## Will Custom Post Types be supported?
-Yes, for the most part. If a post type disables the content field the idea is the "advanced" section at the bottom would fill the page.
+
+Yes, for the most part. If a post type disables the content field, the "advanced" section at the bottom would fill the page.


Could emphasize that this is not currently the case.

Worth a mention capabilities that we might want to offer for building blocks in a custom post type?

Yes, there are a few things you can do (like unregister a bunch of blocks for CPT) that is not the ideal interface.

aduth · 2017-10-13T17:33:38Z

docs/faq.md


 ## Will there be columns?
-Columns are not meant to be part of the initial version since we want to focus on a solid block foundation first. As Gutenberg ties into the following customization focus, things like columns are going to be explored.
+
+Our primary goal is on a solid block foundation before exploring column support.


Worth a reference to nested blocks, at least in how it would enable a path forward for columns? (Even though it is the very next question)

aduth · 2017-10-13T17:36:16Z

docs/faq.md

 Custom TinyMCE buttons will still work in the "Classic Text" block, which is a block version of the classic editor you know today.

 (Gutenberg comes with a new universal inserter tool, which gives you access to every block available, searchable, sorted by recency and categories. This inserter tool levels the playing field for every plugin that adds content to the editor, and provides a single interface to learn how to use.)

 ## How will shortcodes work in Gutenberg?
-Shortcodes will continue to work as they do now.
+`Shortcodes` will continue to work as they do now.


Why the code ticks? Seems reasonable enough as a non-code term.

aduth · 2017-10-13T17:37:26Z

docs/faq.md


-If you would like to contribute to the accessibility of Gutenberg, we could always use people to test, and contribute.
+Accessibility is not an afterthought. Not every aspect of Gutenberg is accessible at the moment, but we are tracking issues in https://github.com/WordPress/gutenberg/labels/Accessibility, and we are fixing them. We understand that WordPress is for everyone, and that accessibility is about inclusion. This is a key value for us.


Wondering if we ought to be using more inline links we are [tracking issues](https://...) and are

aduth · 2017-10-13T17:38:49Z

docs/faq.md


 This also <a href="https://github.com/WordPress/gutenberg/issues/1516">gives us the flexibility</a> to store those blocks that are inherently separate from the content stream (reusable pieces like widgets or small post type elements) elsewhere, and just keep token references for their placement.

+We suggest you look at the [language of Gutenberg](/language/) to learn more about how this aspect of the project works.


Would a relative link ../language/ be better supported for if/when these docs are moved further down a subdirectory?

Update FAQ section in the docs.

d36afd2

mtias added the [Type] Developer Documentation Documentation for developers label Oct 12, 2017

mtias added 2 commits October 12, 2017 17:27

Add missing link.

c4cae06

Clean up formatting.

364fc95

aduth reviewed Oct 13, 2017

View reviewed changes

Improve cpt section; include inline links and images.

d389a99

mtias merged commit 2ff4ba9 into master Oct 18, 2017

mtias deleted the update/faq branch October 18, 2017 09:30

snyk-bot mentioned this pull request Jun 24, 2021

[Snyk] Security upgrade node-sass from 4.14.1 to 6.0.1 Verdinjoshua26/gutenberg#13

Open

This was referenced Aug 4, 2021

[Snyk] Security upgrade node-sass from 4.14.1 to 5.0.0 Verdinjoshua26/gutenberg#15

Open

[Snyk] Security upgrade node-sass from 4.14.1 to 5.0.0 Verdinjoshua26/gutenberg#16

Open

snyk-bot mentioned this pull request Sep 1, 2021

[Snyk] Security upgrade node-sass from 4.14.1 to 5.0.0 Verdinjoshua26/gutenberg#17

Open

Verdinjoshua26 mentioned this pull request Jun 20, 2023

[Snyk] Fix for 1 vulnerabilities Verdinjoshua26/gutenberg#71

Open

This was referenced Mar 22, 2024

[Snyk] Security upgrade node-sass from 4.14.1 to 5.0.0 Verdinjoshua26/gutenberg#110

Open

[Snyk] Fix for 2 vulnerabilities Verdinjoshua26/gutenberg#111

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update FAQ section in the docs. #3011

Update FAQ section in the docs. #3011

mtias commented Oct 12, 2017

codecov bot commented Oct 12, 2017 •

edited

Loading

aduth Oct 13, 2017

aduth Oct 13, 2017

aduth Oct 13, 2017

mtias Oct 18, 2017

aduth Oct 13, 2017

aduth Oct 13, 2017

mtias Oct 18, 2017

aduth Oct 13, 2017

aduth Oct 13, 2017

aduth Oct 13, 2017

aduth Oct 13, 2017


		Our goal with Gutenberg is not just to create a seamless post- and page-building experience. We also want to ensure that it provides a seamless writing experience. Though individual paragraphs of text will become their own “blocks,” the creation and editing of these blocks are being designed in a way that could be just as simple—if not more so—than the current WordPress editor experience. Here is a brief animation illustrating the Gutenberg writing experience:

		https://make.wordpress.org/core/files/2017/08/typing.gif


		## Does Gutenberg involve editing posts/pages in the front-end?

		No, we are designing Gutenberg primarily as a replacement for the post and page editing screens. That said, front-end editing is often confused with an editor that looks exactly like the front end. And that is something that Gutenberg will allow as themes customize individual blocks and provide those styles to the editor. Since content is designed to be distributed across so many different experiences—from desktop and mobile to full-text feeds and syndicated article platforms—we believe it's not ideal to create or design posts from just one front-end experience.


		If you would like to contribute to the accessibility of Gutenberg, we could always use people to test, and contribute.
		Accessibility is not an afterthought. Not every aspect of Gutenberg is accessible at the moment, but we are tracking issues in https://github.com/WordPress/gutenberg/labels/Accessibility, and we are fixing them. We understand that WordPress is for everyone, and that accessibility is about inclusion. This is a key value for us.


		This also <a href="https://github.com/WordPress/gutenberg/issues/1516">gives us the flexibility</a> to store those blocks that are inherently separate from the content stream (reusable pieces like widgets or small post type elements) elsewhere, and just keep token references for their placement.

		We suggest you look at the [language of Gutenberg](/language/) to learn more about how this aspect of the project works.

Update FAQ section in the docs. #3011

Update FAQ section in the docs. #3011

Conversation

mtias commented Oct 12, 2017

codecov bot commented Oct 12, 2017 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Oct 12, 2017 •

edited

Loading