chore(doc): Fix variable issue in submit to showcase/starter docs #20373
Conversation
|
Probably duplicate of #20365 |
|
@DanielRuf , it is not a duplicate. Look at changes of #20365 : https://github.com/gatsbyjs/gatsby/pull/20365/files |
|
It tries to solve the same issue. I saw the differences but we should close one of both. |
| @@ -50,7 +50,7 @@ Use the following template to ensure required fields are filled: | |||
| - title: (required) | |||
| url: (required) | |||
| main_url: (required) | |||
| source_url: (optional - https://github.com/{username}/{titleofthesite}) | |||
| source_url: (optional - https://github.com/username/titleofthesite) | |||
There was a problem hiding this comment.
| source_url: (optional - https://github.com/username/titleofthesite) | |
| source_url: (optional - https://github.com/{username}/{repository(_name)}) |
What do we think of something like this? Do you still have the same inclination about replacement?
I worry that if we drop all the curly braces it doesn't draw your attention to the changes you need to make in the template. Another option is <> but I'm not sure that would have solved the misunderstanding.
There was a problem hiding this comment.
I see your point. Let's maybe do it more KISS. I suggest revert back all changes besides line 31 => 7211473#diff-94bc22b42ee6b592b2c39e07adc7cbe0R31. To be honest, the only line 31 makes the biggest confusion. Otherwise, we might end up with something more complicated and not clear. @laurieontech wdty?
There was a problem hiding this comment.
That makes sense to me. Would you mind making the update and then we can merge it in? Thanks for the discussion on this!
wwwebman
force-pushed
the
fix/fix-submit-to-site-showcase-doc
branch
from
7211473 to
2519c17
Compare
|
Looks good. Thanks for the discussion and PR @wwwebman! Hopefully this will clear up that source of confusion for others. |
Description
As contributor I would like to have a clear understanding of "submit site to showcase" contribution. The issue I see in this doc is a
{titleofthesite}, {username}variables misunderstanding. Some of contributors threat it as a real variable which they can put to e.g.description sectionand it will be replaced on built time. But it does not work this way.This fix should prevent contributors to use
{titleofthesite}and{username}by making clear that these are not variables.Documentation
https://www.gatsbyjs.org/contributing/site-showcase-submissions/
Related to: https://www.gatsbyjs.org/contributing/submit-to-starter-library/
Related Issues
Related to #20365
Related to #20332