docs(typos): fixing various typos found via vale.sh #46
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Going to hold on this until we determine how we're going to manage docs that should be both on the web site and in the repo / app. I feel like this won't be the place for us to update things now that we've released. Also, if we decide this PR should go in, then it wouldn't meet the contributor's guidelines, as there's no associated ticket |
|
While we decide where/how docs will be managed, they are already in the repo and this PR doesnt change the content, just some of the typos we had in there. I dont think it will hurt anything to merge it. If not, applying them again in the future will probably have conflicts. @viega thoughts? As for the ticket, do we really need a ticket for fixing typos? I can create one but this doesnt PR doesnt actually change any of the code/content. IMO ticket is not necessary. |
jamesmoss
approved these changes
Oct 19, 2023
miki725
added a commit
that referenced
this pull request
Oct 19, 2023
* Use explicit targets for module imports * Removing the default config store; for current semantics the CWD default seems better than assuming a URL. * Did a lint pass; dealt with some unused variables, including turning off the 'hint' messages for stuff we want to keep around * Add in some of the new configs. * A tiny bit of polishing * tweak * Some beautification * Initial untested param work done * fixing missing quote from the wrap_entrypoints.c4m * ionly downloading chalk binaries when doing docker build * bumping con4m which fixes is_file path resolution * Have the arch binary updating happen any time an update happens. * Add dumping for cached config modules too * Get rid of old configs * Incorporate new versions of con4m / nimu with ability to get an external IP associated w/ the host portably. Used it in the reporting server to make it not be hacky, and added PUBLIC_IPV4_ADDR_WHEN_CHALKED and _OP_PUBLIC_IPV4_ADDR. * Clean up a bit * Update release notes; integrate Mark's change in tag-line * Update autocomplete. * Fixed circular imports * Remove the chalk report from `chalk load`. It isn't needed and is too much for good intros to the product. * bump nimu * fix(docgen): add con4m defintions to fix docgen cmd regression * docs(typos): fixing various typos found via vale.sh (#46) * fix(docker): wrap_entrypoint honors command args As chalk exec would parse the full command, if it had any arguments chalk was not familiar with, chalk would not parse it correctly and therefore will call command incorrectly. By adding -- after the command name, chalk ignores rest of the args and passes them as-is to the command. For example this now works: ``` ENTRYPOINT ["ls", "-la"] ``` As chalk will end up calling it as: ``` /chalk exec --exec-command-name=ls -- -la ``` * Updated two of the howtos * reverting dockerfile change * Re-add in the ability to dump to a file * fix(docs): fix doc/link regressions * fix(docs): link fix * fix(docs): more reformatting / regression fixing * fix(docs): shockingly, more formatting fixes * fix(docs): reverting the multiple regression fixes because there wasn't a regression * Don't let docgen output static docs * fix(docs) formatting * fix(README): fix link to docker howto * ansi fix --------- Co-authored-by: Miroslav Shubernetskiy <miroslav@miki725.com> Co-authored-by: Rich Smith <rich@crashoverride.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Run all docs through vale and fixed spelling issues it found. Had to add a few words locally to the wordlist in case people want to use it locally as well:
Testing