plone / volto

React-based frontend for the Plone Content Management System
https://demo.plone.org/
MIT License
426 stars 574 forks source link

Added language in codeblocks #3165

Closed ktsrivastava29 closed 2 years ago

ktsrivastava29 commented 2 years ago

I'm adding languages to codeblocks in md files. There are a few code blocks that don't have a language for their lexer, and Pygments isn't always smart enough to figure out what language is intended. The language should be stated as follows:

```language

code

fix: https://github.com/plone/volto/issues/3090
also see: https://github.com/plone/volto/pull/3155
netlify[bot] commented 2 years ago

Deploy Preview for volto ready!

Name Link
Latest commit 88056c6494a3002d4fffc4dbc37344670a07e49f
Latest deploy log https://app.netlify.com/sites/volto/deploys/6240337be0d441000912c15c
Deploy Preview https://deploy-preview-3165--volto.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

ktsrivastava29 commented 2 years ago

@stevepiercy as you instructed, I've closed this PR and opened another from this repo itself; could you kindly check into it now?

ktsrivastava29 commented 2 years ago

@stevepiercy Thank you, now I've made these modifications, could you please take a look at it?

stevepiercy commented 2 years ago

You will also need to resolve merge conflicts with master again.

ktsrivastava29 commented 2 years ago

@stevepiercy I've now fixed the indent and have also resolved the conflicts

stevepiercy commented 2 years ago

@ktsrivastava29 please check the preview build and note the list is now broken.

https://deploy-preview-3165--volto.netlify.app/recipes/creating-project.html

Please build the docs locally, and inspect a preview locally, before pushing more commits.

ktsrivastava29 commented 2 years ago

@stevepiercy I've fixed that, please let me know how can I make it better

stevepiercy commented 2 years ago

@ktsrivastava29 again, please check the preview. And not just for this one file, but for all files you have touched.

https://deploy-preview-3165--volto.netlify.app/recipes/creating-project.html

Before pushing any more commits to this pull request, and asking for another review, first build the docs locally and preview them to ensure that they render correctly.

ktsrivastava29 commented 2 years ago

@stevepiercy I sincerely apologize for bothering you again; actually, I went through each file I edited and fixed the indent where necessary; locally, everything was great, but when I pushed, the test failed; could you kindly assist me in resolving this error?

stevepiercy commented 2 years ago

@ktsrivastava29 the failure can be resolved by rebasing your branch onto master, then force pushing it. We recently added the linkcheck requirement in GitHub Actions, but it is not in your branch's Makefile.

ktsrivastava29 commented 2 years ago

@stevepiercy I've fixed all and double-checked everything; I apologise for taking up so much of the time. Actually previously, I was receiving some HTTPS errors, which took me a day to resolve, and then I got an error due to the improper directory name; after resolving all of these, I was able to go through the suggested changes and then modify it.

ktsrivastava29 commented 2 years ago

@stevepiercy I've made the changes you recommended; please take a look now.

ktsrivastava29 commented 2 years ago

@stevepiercy Oh, I'm sorry, I wrongly placed it; I've fixed it now.

ktsrivastava29 commented 2 years ago

@stevepiercy Previously, only one test failed; now, two have failed. I haven't made any changes since the last push, except for the minor change in the gitignore file that you suggested.

stevepiercy commented 2 years ago

The failing docs build will be fixed in https://github.com/plone/volto/pull/3196. We can ignore that failure.

For the failing core sandbox tests build, I am not sure. @tiberiuichim or @sneridagh, have you got any idea? I restarted that failure to see if it was just a temporary connection issue. Let's see if it fails again. I restarted that failed build for my PR, and it just now passed.

stevepiercy commented 2 years ago

We just merged https://github.com/plone/volto/pull/3196, so the docs build should now pass, I think.

stevepiercy commented 2 years ago

meh, nm, docs build still breaks because this PR has not switched to use plain old docs-linkcheck. The docs build failure may be ignored.

nileshgulia1 commented 2 years ago

@ktsrivastava29 You can try rebasing your PR with master.

stevepiercy commented 2 years ago

Oops, actually, it looks like the docs test now passes. Nevermind about rebasing or merging. Let's wait for all green, then you can merge.

ktsrivastava29 commented 2 years ago

@stevepiercy @nileshgulia1 Thank you; this is my third PR in this organisation, and I'm overjoyed as after 10 days it finally got approved. I'm learning a lot from your experiences. I'm eager to learn and contribute as much as I can.

stevepiercy commented 2 years ago

@ktsrivastava29 please do the honor of merging your PR.

ktsrivastava29 commented 2 years ago

@stevepiercy Sorry, you will have to do it because the base branch restricts merging to me, perhaps only the core team is authorized to merge into master.