Skip to content

docs: improve markdown backport to 13.3.x#45590

Closed
josmar-crwdstffng wants to merge 2 commits intoangular:13.3.xfrom
josmar-crwdstffng:markdownCleanUpdate_2022APR11
Closed

docs: improve markdown backport to 13.3.x#45590
josmar-crwdstffng wants to merge 2 commits intoangular:13.3.xfrom
josmar-crwdstffng:markdownCleanUpdate_2022APR11

Conversation

@josmar-crwdstffng
Copy link
Contributor

Duplicate of #45325 that targets 13.3.x

The purpose of the changes is to clean all markdown to match a single pedantic style.

  • To ensure all changes in style are properly separated.

  • To ensure all styled content aligns to nearest 4-character-tab.

  • To ensure all code blocks use the Angular <code-example> or <code-tab> elements.

  • To ensure all markdown exists outside of html tags.

  • To ensure all images use the Angular style for <img> elements.

  • To ensure that all smart punctuation is replaced or removed.

    ’, ’, “, ”, –, —, …
    
  • To ensure all content does not conflict with the following reserved characters.

    @, $, *, &, #, |, <, >,
    
  • To ensure all content displays using html entities.

The following changes were made to files in the following directory.

aio/content

The target files were markdown files.
The list of excluded files:

.browserslistrc, .css, .conf, .editorconfig, .gitignore, .html, .js, .json, .sh, .svg, .ts, .txt, .xlf,

PR Checklist

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.io application / infrastructure changes
  • Other... Please describe: Documentation markdown formatting.

What is the current behavior?

Updating markdown to be consistent across the docs.

Does this PR introduce a breaking change?

  • Yes
  • No

@jessicajaniuk jessicajaniuk added PullApprove: disable target: patch This PR is targeted for the next patch release action: merge The PR is ready for merge by the caretaker merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note labels Apr 11, 2022
improve markdown for documentation. Duplicate of angular#45325 that targets 13.3.x.
@josmar-crwdstffng josmar-crwdstffng force-pushed the markdownCleanUpdate_2022APR11 branch from b62c437 to f9c05e7 Compare April 11, 2022 18:53
Copy link
Contributor

@jessicajaniuk jessicajaniuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a backport only of an already approved PR.

@ngbot ngbot bot added this to the Backlog milestone Apr 11, 2022
@josmar-crwdstffng josmar-crwdstffng force-pushed the markdownCleanUpdate_2022APR11 branch from 686e81e to ec389ab Compare April 11, 2022 20:23
@josmar-crwdstffng josmar-crwdstffng force-pushed the markdownCleanUpdate_2022APR11 branch from ec389ab to dd1dd43 Compare April 11, 2022 22:16
@mary-poppins
Copy link

You can preview dd1dd43 at https://pr45590-dd1dd43.ngbuilds.io/.

@jessicajaniuk
Copy link
Contributor

This PR was merged into the repository by commit 6189457.

jessicajaniuk pushed a commit that referenced this pull request Apr 11, 2022
improve markdown for documentation. Duplicate of #45325 that targets 13.3.x.

PR Close #45590
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators May 12, 2022
@josmar-crwdstffng josmar-crwdstffng deleted the markdownCleanUpdate_2022APR11 branch May 19, 2022 23:22
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

action: merge The PR is ready for merge by the caretaker merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note PullApprove: disable target: patch This PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants