Skip to content

remove extraneous linebreaks #1025

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
4 tasks done
zjalexander opened this issue Feb 9, 2017 · 15 comments
Closed
4 tasks done

remove extraneous linebreaks #1025

zjalexander opened this issue Feb 9, 2017 · 15 comments
Assignees
Labels
area-helpsystem Area - Help services (pipeline, get/update-help) Pri3 Priority - Low

Comments

@zjalexander
Copy link
Contributor

Issue Details

"we should probably script something up at some point to get rid of all the extraneous line breaks that got caused by too many conversions of content over the years. I can’t think of a reason why we’d ever want more than one empty line at a time in help" - @joeyaiello

Version(s) of document impacted

  • Impacts 5.1 document
  • Impacts 5.0 document
  • Impacts 4.0 document
  • Impacts 3.0 document
@zjalexander
Copy link
Contributor Author

@sdwheeler
Copy link
Contributor

@zjalexander Is this a PlatyPS issue or do we have work to fix the markdown? Is there an example topic you can link to?

@MSAdministrator
Copy link
Contributor

Same with this, if you want some help I can run through these fairly quickly.

@sdwheeler
Copy link
Contributor

@MSAdministrator Go for it.

@MSAdministrator
Copy link
Contributor

Awesome, I’m working through them as we speak. Scripted some of it, but some is too complex (unless I’m not thinking of something). I should have all versions (3.0 - 6) updated with the same format across the board. :)

@sdwheeler
Copy link
Contributor

@MSAdministrator Keep the number of files per PR down to 10 or fewer. That will make it easier to review the changes.

@MSAdministrator
Copy link
Contributor

Will do! @sdwheeler I’ll submit a single PR tonight to make sure everyone is cool with it.

@MSAdministrator
Copy link
Contributor

@sdwheeler An example of my changes across all the docs is in #2070

@sdwheeler
Copy link
Contributor

To anyone who wants to contribute to docs:

The goal of this Issue is to remove unneeded or erroneous extra lines in the articles. Extra lines in the example output blocks are errors. Extra lines in the Markdown paragraphs are unneeded since they will be reduced to a single blank line when rendered on the web page. However, multiple blank lines fills the screen and makes for a poor experience in the console window.

Also, please read the Contributor's Guide. There have been many changes and updates added recently.

@sdwheeler
Copy link
Contributor

Bobby has a tool that does this. He is working on this cleanup.

@sdwheeler sdwheeler added the in-progress Tag - issue is being worked on by someone label Jun 1, 2018
@sdwheeler sdwheeler added the area-helpsystem Area - Help services (pipeline, get/update-help) label Oct 30, 2018
@doctordns
Copy link
Contributor

is this issue still 'live'?

@sdwheeler sdwheeler added the review-shiproom Waiting - for Shiproom discussion label Jan 7, 2019
@sdwheeler
Copy link
Contributor

@doctordns Yes, it is still active. However, the effort is limited to fixing articles as they are touched for other reasons. So there may not be a need to track this issue.

@joeyaiello
Copy link
Contributor

I'd like to leave this open just in case someone does decided to go to the effort of scripting the long tail.

@MSAdministrator
Copy link
Contributor

I was working on this for bit but had some technical issues (e.g. I deleted my local branch on accident). I’ll try and get to this soonish if no one else does

@sdwheeler sdwheeler removed the review-shiproom Waiting - for Shiproom discussion label Jan 9, 2019
@sdwheeler
Copy link
Contributor

This has been done in bulk. If there new cases found, please open a new issue for the specific document.

@sdwheeler sdwheeler removed the in-progress Tag - issue is being worked on by someone label Jun 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-helpsystem Area - Help services (pipeline, get/update-help) Pri3 Priority - Low
Projects
None yet
Development

No branches or pull requests

7 participants