diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index f4f6b6a..31fb442 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -22,8 +22,8 @@ video::jfKfPfyJRdk[youtube] a|* https://docs.asciidoctor.org[AsciiDoc, window=blank] * https://docs.antora.org[Antora, window=blank] * https://vale.sh[Vale] -a|* https://github.com[Github, window=blank] -* https://gitlab.com[Gitlab, window=blank] +a|* https://github.com[GitHub, window=blank] +* https://gitlab.com[GitLab, window=blank] a|* https://drive.google.com[Google Drive, window=blank] * https://gitlab.com/antora/antora-ui-default[Modified Antora Default Theme, window=blank] a|* https://code.visualstudio.com/[VS Code, window=blank] @@ -31,7 +31,7 @@ a|* https://code.visualstudio.com/[VS Code, window=blank] |=== === Contribute -If you want to contribute to the Documentation Cafe, please https://github.com/IvyCap/documentation-cafe/issues/new[submit an issue on our Github page]. +If you want to contribute to the Documentation Cafe, please https://github.com/IvyCap/documentation-cafe/issues/new[submit an issue on our GitHub page]. //==== Licsense diff --git a/docs/modules/ROOT/pages/portfolio.adoc b/docs/modules/ROOT/pages/portfolio.adoc index fc8269d..dda12d4 100644 --- a/docs/modules/ROOT/pages/portfolio.adoc +++ b/docs/modules/ROOT/pages/portfolio.adoc @@ -8,14 +8,14 @@ https://www.linkedin.com/in/kylermonteith/[My LinkedIn Profile, window=blank] * AsciiDoc, Markdown * OpenAPI, YAML, JSON * Antora, Swagger, AsciiDoctor-PDF, Vale -* Github, Gitlab, Git, Jira -* Confluence, Wordpress, Zendesk, Salesforce +* GitHub, GitLab, Git, Jira +* Confluence, WordPress, Zendesk, Salesforce * VS Code, Google Suite, LibreOffice == Additional Technical Skills and Tools * Linux, Windows, macOS, command line * Docker, AWS, Azure, Digital Ocean -* Bash Shell Scripting, RegEx, HTML, XML, CCS, Javascript, Python, Rust +* Bash Shell Scripting, RegEx, HTML, XML, CCS, JavaScript, Python, Rust * SQL, MongoDB, Firebase * Postman, Rest APIs * LivePerson, Slack, Discord, MS Teams, Zoom, Google Chat @@ -47,7 +47,7 @@ xref:portfolio:tldr.adoc[tldr] is an open source project to create simplified ma === Personal Projects Below are examples of work I have completed for myself -xref:ROOT:index.adoc[Documentaion Cafe] is a site I created to document my interests and practice my technical writing skills. +xref:ROOT:index.adoc[Documentation Cafe] is a site I created to document my interests and practice my technical writing skills. * xref:thoughts:troubleshooting.adoc[Troubleshooting: Working the Problem] diff --git a/docs/modules/drinks/pages/winters-kiss.adoc b/docs/modules/drinks/pages/winters-kiss.adoc index 256efba..cbe1115 100644 --- a/docs/modules/drinks/pages/winters-kiss.adoc +++ b/docs/modules/drinks/pages/winters-kiss.adoc @@ -3,7 +3,7 @@ [CAUTION] .Food Blogger Nonsense ==== -Winter's Kiss was developed when I wanted to make Death & Co's Wicked Kiss but did not have any yellow chartreuse on hand. Looking through my liquor cabinet for something to replace it with I notice the bottle of allspice dram and thought I would give it a shot. Turned out I really enjoyed the mixture and it has now become one of my goto cocktails. A note on history Death & Co's Wicked Kiss is based on Widow's Kiss. +Winter's Kiss was developed when I wanted to make Death & Co's Wicked Kiss but did not have any yellow chartreuse on hand. Looking through my liquor cabinet for something to replace it with I notice the bottle of allspice dram and thought I would give it a shot. Turned out I really enjoyed the mixture and it has now become one of my go to cocktails. A note on history Death & Co's Wicked Kiss is based on Widow's Kiss. ==== == Recipe diff --git a/docs/modules/git/pages/git-quick-guide.adoc b/docs/modules/git/pages/git-quick-guide.adoc index 8d301d7..0af330d 100644 --- a/docs/modules/git/pages/git-quick-guide.adoc +++ b/docs/modules/git/pages/git-quick-guide.adoc @@ -16,8 +16,8 @@ git clone https://{serverAdress.xyz[port]/path/to/project/repoName.git} git clone ssh://{user@serverAddress.xyz[port]:/path/to/project/repoName.git} ---- -=== git clone private Github repo with MFA enabled -First you will need to obtain a Personal Access Token (PTA) from your Github account. Settings > Developer Settings > Personal access token > Fine-grained tokens. Add the token to the repo url as shown below. +=== git clone private GitHub repo with MFA enabled +First you will need to obtain a Personal Access Token (PTA) from your GitHub account. Settings > Developer Settings > Personal access token > Fine-grained tokens. Add the token to the repo url as shown below. .HTTPS clone with PAT ---- @@ -61,7 +61,7 @@ git config --global user.password"{password}" ---- git config --local user.passowrd "{password}" ---- -.Enable global credetntial storage +.Enable global credential storage ---- git config --global credential.helper store ---- diff --git a/docs/modules/linux/pages/linux-commands.adoc b/docs/modules/linux/pages/linux-commands.adoc index c4ada14..d346b07 100644 --- a/docs/modules/linux/pages/linux-commands.adoc +++ b/docs/modules/linux/pages/linux-commands.adoc @@ -1,10 +1,10 @@ -= Usfull Linux Commands += Useful Linux Commands == Sudo!! -This is a command I find my self using alot. If you ever forget to add sudo to the begining of a command you typed sudo !! will rerun the previous command with sudo. +This is a command I find myself using a lot. If you ever forget to add sudo to the beginning of a command you typed sudo !! will rerun the previous command with sudo. ---- $ apt upgrade - requires sudo privalages + requires sudo privileges $ sudo !! password: sudo apt upgrade diff --git a/docs/modules/markup-languages/pages/asciidoc-quick-guide.adoc b/docs/modules/markup-languages/pages/asciidoc-quick-guide.adoc index 10aaef4..c628448 100644 --- a/docs/modules/markup-languages/pages/asciidoc-quick-guide.adoc +++ b/docs/modules/markup-languages/pages/asciidoc-quick-guide.adoc @@ -105,7 +105,7 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor i Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum == Lists -=== Orderd Lists +=== Ordered Lists ---- . One . Two @@ -231,7 +231,7 @@ video::local-video-file.mp4[] video::loccal-video-file.mp4[width=640,start=60,opts=autoplay] ---- -.Embedded Youtube +.Embedded YouTube ---- video::jfKfPfyJRdk[youtube] ---- @@ -290,7 +290,7 @@ Link to <> anchor Go to the <> section to learn more about lists -To learn lamore about <> +To learn more about <> Link to <> anchor diff --git a/docs/modules/markup-languages/pages/markdown.adoc b/docs/modules/markup-languages/pages/markdown.adoc index a2b59d4..3156c6f 100644 --- a/docs/modules/markup-languages/pages/markdown.adoc +++ b/docs/modules/markup-languages/pages/markdown.adoc @@ -211,7 +211,7 @@ I thinks you should use an `` element here instead. ---- == Ignoring Markdown Formatting -Add a `\` before and after the formatting marks to stop the formattingfrom being rendered. +Add a `\` before and after the formatting marks to stop the formatting from being rendered. ---- This text will not show as \**bold**\ or \*italics*\ in rendered markdown. ---- diff --git a/docs/modules/portfolio/pages/pm-projects.adoc b/docs/modules/portfolio/pages/pm-projects.adoc index 04105dc..2397d9e 100644 --- a/docs/modules/portfolio/pages/pm-projects.adoc +++ b/docs/modules/portfolio/pages/pm-projects.adoc @@ -1,4 +1,4 @@ -= Project/Program Managment Projects += Project/Program Management Projects == Employer Projects diff --git a/docs/modules/portfolio/pages/tw-projects.adoc b/docs/modules/portfolio/pages/tw-projects.adoc index abc9c08..d2faae7 100644 --- a/docs/modules/portfolio/pages/tw-projects.adoc +++ b/docs/modules/portfolio/pages/tw-projects.adoc @@ -19,7 +19,7 @@ xref:portfolio:tldr.adoc[tldr] is an open source project to create simplified ma == Personal Projects Below are examples of work I have completed for myself -xref:ROOT:index.adoc[Documentaion Cafe] is a site I created to document my interests and practice my technical writing skills. +xref:ROOT:index.adoc[Documentation Cafe] is a site I created to document my interests and practice my technical writing skills. * xref:thoughts:troubleshooting.adoc[Troubleshooting: Working the Problem] diff --git a/docs/modules/thoughts/pages/troubleshooting.adoc b/docs/modules/thoughts/pages/troubleshooting.adoc index b13add0..733d84f 100644 --- a/docs/modules/thoughts/pages/troubleshooting.adoc +++ b/docs/modules/thoughts/pages/troubleshooting.adoc @@ -35,7 +35,7 @@ After the explosion on the command module in the movie Apollo 13, Gene Kranz the ** The troubleshooting tools we have access to can help you determine the cause of an issue, and direct you to the troubleshooting steps to attempt * Read the Documentation ** We have a lot of documentation that can help you solve the problem -** Use search engines, there is a good chance someone else has experinced this issue and solved it +** Use search engines, there is a good chance someone else has experienced this issue and solved it * Ask Co-Workers Questions and for Assistance ** Reach out to your co-works, as there is a chance that one of us has experienced this issue before. ** Use Internal Chat, Daily Stand Up meetings or team meetings @@ -61,7 +61,7 @@ After the explosion on the command module in the movie Apollo 13, Gene Kranz the * Document the troubleshootings steps tried and the results of the steps * Gather and document screenshots, video, logs... . Escalate the Problem -* If you have reached the point where you are no longer able to troubleshoot the problem escalate the issue to the Tier 2 (T2) support queue or create a jira ticket in the appropriate project +* If you have reached the point where you are no longer able to troubleshoot the problem escalate the issue to the Tier 2 (T2) support queue or create a Jira ticket in the appropriate project * Set the proper customer expectations * If escalating to T2: “Thank you for all the details we’ve captured to this point. I’m going to now escalate this to a Senior member of our team to look into this further.” - Gauge urgency - unless outage (24-48 hours) to hear back from escalated Support * If escalating to a developer “Thank you for all the details we’ve captured to this point. This does appear to be an issue that will require prioritization and scoping from our Engineering team. Unfortunately, they are already in a current sprint, so we will work to get this to make one of the next sprints if they are capable against their current list of priorities.” - Gauge urgency - unless outage (“usually this takes 2 weeks to hear back”) diff --git a/styles/config/vocabularies/doccafe/accept.txt b/styles/config/vocabularies/doccafe/accept.txt index c089cec..730a82b 100644 --- a/styles/config/vocabularies/doccafe/accept.txt +++ b/styles/config/vocabularies/doccafe/accept.txt @@ -1,19 +1,24 @@ Bulletish masala chai +[Uu]nstaged +[Rr]ebase +[Tt]roubleshootings repo -url +(?i)url +[Ss]trikethrough +[Rr]eferenceable uuid UUID Kranz [Ss]udo Tenfold's config -html -xhtml +(?i)html +(?i)xhtml xreflabel jackalopes -pdf +(?i)pdf [Mm]onospace [Rr]oleplaying Tendold @@ -73,4 +78,4 @@ qui officia deserunt mollit -laborum +laborum \ No newline at end of file