Codeberg/Documentation
42
199
Fork
You've already forked Documentation
161

Edit section, foobar is nice but we are dealing with the 'examples' repository #186

Closed
aniston wants to merge 1 commit from aniston/Documentation:main into main
pull from: aniston/Documentation:main
merge into: Codeberg:main
Codeberg:main
Codeberg:renovate/major-cspell-monorepo
Codeberg:renovate/mstruebing-editorconfig-checker-3.x
Codeberg:renovate/lycheeverse-lychee-0.x
Codeberg:renovate/font-awesome
Codeberg:renovate/prettier-3.x
Codeberg:renovate/markdownlint-cli2-0.x
Codeberg:renovate/markdown-it-14.x
Codeberg:renovate/davidanson-markdownlint-cli2-0.x
Codeberg:renovate/pipelinecomponents-yamllint-0.x
Codeberg:renovate/11ty-eleventy-3.x
Codeberg:renovate/node-lts-slim
Codeberg:renovate/npm-pnpm-vulnerability
Codeberg:ci_pr_close_no_preview
Codeberg:pr-554
Codeberg:pr/554
Codeberg:gitea-icons-shortcode
First-time contributor
Copy link

Mostly obvious to many but for first time users cd foobar will give then an error as we are dealing wit a repository called 'knut/examples' in this documentation.

Mostly obvious to many but for first time users ```cd foobar``` will give then an error as we are dealing wit a repository called 'knut/examples' in this documentation.
Mostly obvious to many but for first time users ```cd foobar``` will give then an error as we are dealing wit a repository called 'knut/examples' in this documentation.
fnetX left a comment
Copy link

Thanks. Can you make sure not to rewrite the whole file (probably due to line endings)? I'd prefer to see the actual diff.

Thanks. Can you make sure not to rewrite the whole file (probably due to line endings)? I'd prefer to see the actual diff.
fnetX left a comment
Copy link

Hmm didn't meant to approve. The UI is flaky here, the review screen is slow and doesn't fit on my screen, so it's more a guess where I can find the button.

Hmm didn't meant to approve. The UI is flaky here, the review screen is slow and doesn't fit on my screen, so it's more a guess where I can find the button.
Author
First-time contributor
Copy link

@fnetX, that was a quick look into my Pull request !
anyways as asked for clarification:

in the "Edit" Section under clone-commit-via-cli

  • the original cd foobar wants to cd into a foobar directory but in the beforementioned explanation we are dealing with a sample repository called examples , this is confusing for first timers and will probably leave them with a message like "foobar does not exist or cannot be found"

Online version


Edit

Modify an existing file:

~$ cd foobar
~/examples$ nano README.md

Proposed change


Edit

Modify an existing file:

~$ cd examples
~/examples$ nano README.md

Hope this helps to clarify the point.

@fnetX, that was a quick look into my Pull request ! anyways as asked for clarification: in the "Edit" Section under [clone-commit-via-cli](https://docs.codeberg.org/git/clone-commit-via-cli) - the original ```cd foobar``` wants to *cd* into a ```foobar``` directory but in the beforementioned explanation we are dealing with a sample repository called ```examples``` , this is confusing for first timers and will probably leave them with a message like "foobar does not exist or cannot be found" ### *Online version* --- > ## Edit > Modify an existing file: >```shell >~$ cd foobar >~/examples$ nano README.md >``` --- ### *Proposed change* --- ## Edit Modify an existing file: ```shell ~$ cd examples ~/examples$ nano README.md ``` --- Hope this helps to clarify the point.

@aniston could you please re-commit your changes and make sure that only the lines that are actually changed show up in the diff.

@aniston could you please re-commit your changes and make sure that only the lines that are actually changed show up in the diff.
@ -95,0 +48,4 @@
Modify an existing file:
```shell
~$ cd examples
Owner
Copy link

@aniston did you only modify this single occurence? If so, can you please either recreate the commit with correct line endings? I can also do the job, if I was sure this was the only change?

@aniston did you only modify this single occurence? If so, can you please either recreate the commit with correct line endings? I can also do the job, if I was sure this was the only change?
Author
First-time contributor
Copy link

@aniston did you only modify this single occurence? If so, can you please either recreate the commit with correct line endings? I can also do the job, if I was sure this was the only change?

Hallo @fnetX , yes that is the only occourence in the "clone-commit-via-cli" section of the Documentation. The single correction should be enough.

Thanks for looking into it.

> @aniston did you only modify this single occurence? If so, can you please either recreate the commit with correct line endings? I can also do the job, if I was sure this was the only change? Hallo @fnetX , yes that is the only occourence in the "clone-commit-via-cli" section of the Documentation. The single correction should be enough. Thanks for looking into it.
Owner
Copy link

Included this in #189. Thank you for spotting this.

Included this in #189. Thank you for spotting this.
fnetX closed this pull request 2022年01月19日 20:13:09 +01:00
fnetX referenced this pull request from a commit 2022年01月21日 11:36:38 +01:00

Pull request closed

Please reopen this pull request to perform a merge.
Sign in to join this conversation.
No reviewers
Labels
Clear labels
Codeberg Pages
Issues affecting Codeberg Pages
Documentation Usability
Issues related to using and reading docs.codeberg.org
Forgejo
Good First Issue! 👋
Kind: Bug
Kind: Documentation
Kind: Enhancement
Kind: Feature
Kind: Question
Kind: Security
Licensing
Part: Generator
This is related to the generation of the documentation, not to the content itself
Priority: High
The priority is high
Priority: Low
The priority is low
Priority: Medium
The priority is medium
Reviewed: Confirmed
Something has been confirmed
Reviewed: Duplicate
Something exists already
Reviewed: Invalid
Something was marked as invalid
Reviewed: Wontfix
Something won't be fixed
Status: Blocked
Status: Help wanted
Contributions are welcome!
Status: In progress
Work is in progress
Status: Needs feedback
Feedback is needed
Status: Ready for Review
Work is completed
Status: Review
Review is in progress / Reviewers wanted
Status: Stale
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Codeberg/Documentation!186
Reference in a new issue
Codeberg/Documentation
No description provided.
Delete branch "aniston/Documentation:main"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?