docs icon indicating copy to clipboard operation
docs copied to clipboard

refactor(highlight): convert code block declarations from tags to Markdown syntax extensions

Open normal-coder opened this issue 3 years ago • 6 comments
trafficstars

What does this Pull Request do

  • Convert code block declarations in Pipeline documents from tags to Markdown syntax extensions
  • not changed for other specific content

Why do this

  • In Drone's documentation, there are numerous references to code block highlighting declarations similar to {{<highlight yaml "linenos=table" >}} ... {{</ highlight >}}, which is Bright rendering of Markdown documents has a huge experience barrier, and at the same time makes the reading experience of the document repository code extremely poor.
  • In the document, there is another way of writing code block highlighting ```yaml {linenos=table} ... ```, the function is to keep the code block style consistent with the above highlighted declaration, This writing method conforms to the Markdown syntax style and is more concise. It is recommended to use this method. This is also the core purpose of this Pull Request.
  • In fact, the entire document should have a unified code style for easy maintenance, this Pull Request only deals with the documentation of the Pipeline module

normal-coder avatar Sep 11 '22 15:09 normal-coder

Hi @normal-coder we will have this reviewed every Tuesday and team will get back to you after learning the feasibility of request. Feel free to reach us out to us on community slack for quick help.

Thanks

ShruthiHubb avatar Sep 14 '22 13:09 ShruthiHubb

Hi @normal-coder we will have this reviewed every Tuesday and team will get back to you after learning the feasibility of request. Feel free to reach us out on community slack for quick help.

Thanks

It looks great. Due to the many changes to the current position, I am patient enough to wait for the communication with you, and I will join the Slack community later.

normal-coder avatar Sep 14 '22 13:09 normal-coder

Thanks for joining Drone Office Hours today to discuss this.

As I mentioned, please give us a new pull request with a change to a single file, then we can see how it looks and go from there.

Thanks again!

jimsheldon avatar Sep 15 '22 16:09 jimsheldon

@ShruthiHubb @jimsheldon , I've adjusted the commit to a small number of file changes so that it's easier to see the impact of their changes.

For other changed files, I will submit a separate Pull Request for adjustment after the Pull Request is merged. Looking forward to the follow-up communication and feedback.

normal-coder avatar Sep 23 '22 16:09 normal-coder

It seems that the Pull Request has not been reviewed for a long time. Any questions? @jimsheldon

normal-coder avatar Oct 12 '22 07:10 normal-coder

@normal-coder let me check for the updates.

Thanks!

ShruthiHubb avatar Oct 12 '22 08:10 ShruthiHubb