Jquery docs minor improvements #98
Conversation
….com repo. They do not belong to this style guide
|
@scottgonzalez Is there anything else I can help with? Thank you very much in advance. |
| - Ralph Whitbeck <[email protected]> | ||
| - John Paul <[email protected]> | ||
| --- | ||
| ``` |
There was a problem hiding this comment.
I don't think there are sites still using YAML?
There was a problem hiding this comment.
also this shouldn't be learn site specific.
There was a problem hiding this comment.
Correct, there are no sites using YAML.
There was a problem hiding this comment.
Thank you both for your comments. I fail to understand which changes should be made taking into account that there are no sites using YAML and that this should not be learn site specific. Could you explain it to me, please? Thanks in advance.
There was a problem hiding this comment.
To be honest, If you don't know how the architecture of our sites is setup, you're probably not the right guy to handle this.
The thing is that, in the past, we used YAML for front matters in some sites and now we use JSON, but the example in here still uses YAML.
Also, we mean some of the properties you use in your example are specific for the learn site (learn.jquery.com). Those properties are not needed in other sites.
Remember that the original article was specific for learn.jquery.com while this one must be true for every site.
There was a problem hiding this comment.
@arthurvr Thanks for the clarification.
You are right: These is my first contribution to this repository so I am not the right guy to handle this. Let's wait to hear other people's opinion.
|
Doesn't the front-matter need to be in |
|
|
||
| Content should be educational and accessible to a broad audience of developers. The primary target audience is beginning to intermediate jQuery users, with advanced jQuery users as a secondary audience. When creating content, please keep one of these audiences in mind as well as the following style guidelines: | ||
|
|
||
| ### Prose & Grammar |
There was a problem hiding this comment.
Prose is a subheading in an article regarding prose?
| @@ -0,0 +1,111 @@ | |||
| <script>{ | |||
| "title": "Prose Style Guide" | |||
…rties only exist in the lear.jquery.com repo
… learn.jquery.com site
|
I can confirm the CLA was signed. |
|
@agcolom : I am able to amend the spaces to tabs but do not know which spaces you are referring to. Could you tell me about them, please? Thanks in advance. |
|
What does CLA mean? |
|
Is it okay to land this? I was going to make some edits to the pages here but it would be easier to land this first so it doesn't conflict. I can fix the spaces when I land it. |
issue #75