#3564 [docs / code change?] Scope of Issues git repository
Closed: Fixed 5 years ago Opened 5 years ago by cipherboy.

I'm happy to open the corresponding PR to fix this issue if this is a docs change. Otherwise, I'm not familiar with the Pagure codebase if this is a code change...

On the usage section of the Pagure docs is, to my knowledge, the only description of cloning the issues git repository and what the repository can do (can you modify+push to it? only pull?).

However, the mention that these four repos are "admin-only" and not publicly accessible is lost in the paragraph, and (I think?) project specific or wrong in some cases. Comparing freeipa to pagure, pagure lets non-admins clone the docs, but freeipa doesn't:

(Or at least, I'd venture that I'm not an admin of the pagure and I'm not an admin of the freeipa repo :)

I'd like to either extend the documentation to list whether or not each repo is always visible (source code?), project-specific (docs?), or always admin-only (issues / PR metadata), or make them all "publicly visible" if possible.

--

Regarding making them publicly visible is a code change instead of a documentation fix...

I'm not quite sure why PR metadata is restricted-clone (as I don't think PRs can be "private"), though if PR data can be modified and pushed, that would explain and mandate restricted-push.

For issues, private issues do make this admin-only, but it would be nice to have a "download public issues" button which gives equivalent data sans-.git (because we'll be modifying the repository to remove private artifacts) to non-admins, as an archive.

Thoughts?


I don't think PRs can be "private"

The data model allows it, we just have not finished implementing it yet.

Comparing freeipa to pagure, pagure lets non-admins clone the docs, but freeipa doesn't:

The doc repo only shows when the project activates it, I guess freeipa isn't using this feature :)

Basically it is something like:
- source git repo: always public unless private project
- doc git repo: always public when activated (and not private project)
- ticket git repo: ACL >= commit
- PR git repo: ACL >= commit

I very much welcome any and all improvements to the doc, though I believe I may have adjusted this part recently, so what is in git may be a little different from what is currently published (I normally update the doc when I push a new release).

https://pagure.io/pagure/blob/master/f/doc/usage/index.rst is the latest version and seems to include some more context about what is possible to do with the meta-data repos.

Thanks for the reply!

I'll take a look on Monday at the version of docs in the repo and check out the wording and decide to either close this or open a PR. :)

Have you had a chance to go through the docs?

@pingou Sorry, I've been away for a month; I'll take a look at this in the next few days and get back to you (for real!).

Yeah, the docs in-tree look better now. Thanks for your change 13832f2 earlier!

Metadata Update from @cipherboy:
- Issue close_status updated to: Fixed
- Issue status updated to: Closed (was: Open)

5 years ago

Login to comment on this ticket.

Metadata