yadm: add pages #13920
Open
yadm: add pages #13920
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
github-actions
bot
added
the
new command
|
Well I hope this one works now. Creating a new PR was the only way to get rid of the wrong author. |
sebastiaanspeck
requested changes
Oct 1, 2024
There was a problem hiding this comment.
Thank you for your first contribution. Please make sure to read the style guide and contributing guide.
I have added some comments that need to be addressed before the PR is GTG.
| @@ -0,0 +1,9 @@ | |||
| # yadm-bootstrap | |||
|
|
|||
| > This command allows you to execute Yadm's bootstrap file. | |||
There was a problem hiding this comment.
Suggested change
| > This command allows you to execute Yadm's bootstrap file. | |
| > Execute Yadm's bootstrap file. |
|
|
||
| - Create the necessary files and folders for encryption: | ||
|
|
||
| `touch {{encrypt-file-path}} && mkdir {{archive-folder-path}}` |
There was a problem hiding this comment.
Suggested change
| `touch {{encrypt-file-path}} && mkdir {{archive-folder-path}}` | |
| `touch {{path/to/encrypt_file}} && mkdir {{path/to/archive_folder}}` |
|
|
||
| - Share the repository using GPG: | ||
|
|
||
| `yadm git-crypt add-gpg-user {{USER_ID}}` |
There was a problem hiding this comment.
Does the USER_ID need to be capitalised?
| # yadm-perms | ||
|
|
||
| > Update permissions. | ||
| > It is usually unnecessary to run this command, as `yadm` automatically processes permissions by default. This automatic behavior can be disabled by setting the configuration `yadm.auto-perms` to "false". |
There was a problem hiding this comment.
Suggested change
| > It is usually unnecessary to run this command, as `yadm` automatically processes permissions by default. This automatic behavior can be disabled by setting the configuration `yadm.auto-perms` to "false". | |
| > It is usually unnecessary to run this command, as `yadm` automatically processes permissions by default. This automatic behavior can be disabled by setting the configuration `yadm.auto-perms` to `"false"`. |
| - Set the symmetric cipher to utilize for encryption: | ||
|
|
||
| `yadm transcrypt --cipher={{cipher}}` |
There was a problem hiding this comment.
Suggested change
| `yadm transcrypt --cipher={{cipher}}` | |
| `yadm transcrypt --cipher={{cipher}}` |
|
|
||
| - Override the location of the yadm encrypted files archive: | ||
|
|
||
| `yadm --yadm-archive` |
There was a problem hiding this comment.
Suggested change
| `yadm --yadm-archive` | |
| `yadm --yadm-archive` |
|
|
||
| > A dotfiles manager that works by using `git`. | ||
| > The subcommands are just like `git` but use `yadm`. | ||
| > You can use `yadm` (init | clone | push | pull). |
There was a problem hiding this comment.
Suggested change
| > You can use `yadm` (init | clone | push | pull). | |
| > Some subcommands such as `init`, `clone`, `push`, and `pull` have their own usage documentation. |
https://github.com/tldr-pages/tldr/blob/main/CONTRIBUTING.md#referencing-subcommands
| @@ -0,0 +1,13 @@ | |||
| # yadm-upgrade | |||
|
|
|||
| > Use this command upgrade `yadm` to the latest version. | |||
There was a problem hiding this comment.
Suggested change
| > Use this command upgrade `yadm` to the latest version. | |
| > Upgrade `yadm` to the latest version. |
| > Upgrading will attempt to de-initialize and re-initialize your submodules. | ||
| > More information: <https://github.com/TheLocehiliosan/yadm/blob/master/yadm.md#commands>. | ||
| - Upgrade: |
There was a problem hiding this comment.
Suggested change
| - Upgrade: | |
| - Upgrade `yadm` to the latest version: |
| @@ -0,0 +1,13 @@ | |||
| # yadm-enter | |||
|
|
|||
| > Run a sub-shell with all Git variables set. This sub-shell can be used to easily interact with your `yadm` repository using Git commands. | |||
There was a problem hiding this comment.
Suggested change
| > Run a sub-shell with all Git variables set. This sub-shell can be used to easily interact with your `yadm` repository using Git commands. | |
| > Run a sub-shell with all Git variables set. This sub-shell can be used to easily interact with the local `yadm` repository using Git commands. |
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.
common,linux,osx,windows,sunos,android, etc.