Skip to content

doc: formatted example clone repo command as codeblock #7728

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

Merged
merged 2 commits into from
May 1, 2025

Conversation

travisamartin
Copy link
Contributor

@travisamartin travisamartin commented Apr 30, 2025

Proposed changes

This PR makes the following documentation change:

  • Formats the example command for cloning the repo as a codeblock vs in-line code. The in-line format wraps and a user commented on the ending period as an issue (when copying).

The codeblock resolved the wrapping issue and removes the terminating period. Plus, it adds the Copy button.

Before

image

After

image

Survey feedback

image

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@travisamartin travisamartin added the documentation Pull requests/issues for documentation label Apr 30, 2025
@travisamartin travisamartin requested review from a team as code owners April 30, 2025 20:22
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/nginx-ingress-controller/7728/

@travisamartin travisamartin merged commit d157ddb into main May 1, 2025
30 checks passed
@travisamartin travisamartin deleted the doc-fix-code-wrap branch May 1, 2025 15:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests/issues for documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants