search

parse-community / docs

Parse Platform docs
https://docs.parseplatform.org
Other
313 stars 518 forks source link

Refactor AWS Deployment Guide + Block Code Format #879

Closed MrMartinR closed 2 years ago

MrMartinR commented 2 years ago

actually I saw this PR https://github.com/parse-community/docs/pull/840 and I probably have to change the json tojson5 🤔...

dblythy commented 2 years ago

Thanks for this PR @MrMartinR! Does specifying json make much of a difference compared to specifying js?

MrMartinR commented 2 years ago

Hi @dblythy as far as I know, allows comments in block code, (actually I have another PR with that changes)

dblythy commented 2 years ago

Could you possibly send a screenshot of the docs before vs after with the changes? I don’t quite understand the value of the changes

MrMartinR commented 2 years ago
Screen Shot 2022-06-25 at 19 10 25 Screen Shot 2022-06-25 at 19 10 12
dblythy commented 2 years ago

I understand the difference in code; I’m referring to the difference in the way the outputted docs look (you can replicate this with npm run docs and comparing to parseplatform.org). Perhaps I don’t quite understand what the issue that this PR fixes, @MrMartinR feel free to enlighten me 😊

MrMartinR commented 2 years ago

behind the vscode is the output, actually, json5 allow comments, but removes the color label/value another example but in MD file in GitHub is this...

Screen Shot 2022-06-25 at 19 13 11
MrMartinR commented 2 years ago
Screen Shot 2022-06-25 at 19 20 25
MrMartinR commented 2 years ago

Ok, find a solution... using ```jsonc (json with comments) keeps the highligts and not complain about the comments...

image
dblythy commented 2 years ago

Sorry @MrMartinR I was struggling to see. Looks good though!! So should we use jsonc instead?

MrMartinR commented 2 years ago

Yep, looks like jsonc is the best solution, in this PR I changed from js to json, I have another PR pending to do, with changes I made after this PR, I haven't PR yet because It has conflicts, so the idea is to merge this PR and then the next one is where the jsonc will be applied and other stuff that I don't recall right now...

dblythy commented 2 years ago

Right, think your changes might have got overriden when merging conflicts. Have a look at the “files changed” tab, the only changes in this PR are changing js to json.

We value passion and ideas - but let’s make sure to open an issue first and reference that issue in the PR. This helps all of us understand the problem, and what is being fixed. It seems that there are some great ideas in the commits here (that somehow were reset) so I’m looking forward to discussing them in their respective issues.

Plus, it is cool keeping track of how many issues and PRs you have, I am up to 232, only 400 behind @mtrezza 😂

MrMartinR commented 2 years ago

checking this PR, you are right, only the changes to js to json.. 🤷‍♂️.. I am gonna delete this PR, check the Issues, and create the other PR with the Fix in the AWS deployment and the js to jsonc stuff..