Skip to content
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

borg2: wrong syntax in docs #8550

Open
ThomasWaldmann opened this issue Nov 18, 2024 · 7 comments
Open

borg2: wrong syntax in docs #8550

ThomasWaldmann opened this issue Nov 18, 2024 · 7 comments

Comments

@ThomasWaldmann
Copy link
Member

ThomasWaldmann commented Nov 18, 2024

borg2 does not use the repo::archive syntax anymore:

https://borgbackup.readthedocs.io/en/2.0.0b14/usage/general.html#logging

Do a global search for such errors in the docs (master branch).

@vancheese
Copy link

How can I help resolve this issue?

@ThomasWaldmann
Copy link
Member Author

ThomasWaldmann commented Nov 22, 2024

@vancheese thanks for helping!

You could do a global review of the docs (searching for stuff like repo::archive) and then submit a pull request with fixes on github.

The docs consist of:

  • .rst[.inc] files in the docs/ folder.
  • but be careful, some of these files have a comment in the first line telling that they are auto-generated. in that case the text comes from a .py source file usually.
  • text strings extracted from .py source files, see src/borg/archiver/ folder

@vancheese
Copy link

Great, that looks like a great way to get started helping here
Any preferences re branching, naming etc as this first time helper, long-term user ?

@ThomasWaldmann
Copy link
Member Author

As this refers to borg2 only, the fix is only needed in master branch.

We have some docs for (new) developers / contributors there:

https://borgbackup.readthedocs.io/en/stable/development.html

@vancheese
Copy link

What is the best way for asking for some help?

I'm working my way through the reported issue and just testing every command
I've moved to a local fork to prepare for a pull merge and I'm having issues with the version numbers as it appears the forking results in a version which is rejected by version.py module

Is there a way to override/define the version in the pyproject.toml so I can test the documentation etc using the latest git version?
I know this is overkill for a simple doc ticket , but I want to make sure everything works as expected

@ThomasWaldmann
Copy link
Member Author

@vancheese see #8582 and please add the steps to reproduce there.

@vancheese
Copy link

@ThomasWaldmann - Christmas 2024 madnesss here - Not forgotten, will do soon :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants