Skip to content
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

Cleanup line breaks - Asciidoc #386

Closed
erget opened this issue Sep 13, 2022 · 3 comments · Fixed by #387
Closed

Cleanup line breaks - Asciidoc #386

erget opened this issue Sep 13, 2022 · 3 comments · Fixed by #387
Assignees

Comments

@erget
Copy link
Member

erget commented Sep 13, 2022

CF doesn't have a style guide for use in AsciiDoc (yet!) but we've noted at previous meetings that the way the lines are structured in the AsciiDoc files makes it hard to do a git blame and get meaningful results. Putting each sentence on a single line would help get us there and would be a quick hack, but would need to be implemented quickly so that we don't create cumbersome merge conflicts with all the other work in progress. That way for a given sentence we could say who changed what, when, and why.
Ancillary to the initial AsciiDoc tidying we might have a go at an initial style guide to try working with in the following year. Who's game?

@erget erget linked a pull request Sep 13, 2022 that will close this issue
4 tasks
@erget
Copy link
Member Author

erget commented Sep 13, 2022

Don't forget the conformance document!

@erget
Copy link
Member Author

erget commented Sep 13, 2022

vi *adoc, :n, :wa

  • Paragraphs on single line
  • Break at sentence break
  • Check for double spaces

@erget
Copy link
Member Author

erget commented Sep 13, 2022

Exception: When URLs are on a line of their own I leave them there since that might make our lives easier when the page moves.

@erget erget linked a pull request Sep 13, 2022 that will close this issue
@sadielbartholomew sadielbartholomew self-assigned this Sep 13, 2022
Repository owner moved this from In Progress to Done in Housekeeping at 2022 workshop Sep 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

3 participants