questions about documentation

[sssd-bot]

Cloned from Pagure issue: https://pagure.io/SSSD/sssd/issue/3557

• Created at 2017-10-22 22:46:06 by sobek
• Closed at 2018-03-15 11:41:52 as Fixed
• Assigned to nobody

---

Before creating a PR I would like to have your opinion and need your input.

At:
https://docs.pagure.org/SSSD.sssd/users/faq.html#tracking-bugs-and-enhancement-requests
https://docs.pagure.org/SSSD.sssd/developers/contribute.html#tasks-for-newcomers
you can read about "Trac".
Is it OK to replace the word with "issue tracker"?

I found a contradiction in the documentation. At:
https://docs.pagure.org/SSSD.sssd/developers/contribute.html#source-code-repository
You can read:
"For the SSSD project, we use the Git source control system.
https://pagure.io/SSSD/sssd.git
We also maintain a read-only mirror on github."

However, at:
https://docs.pagure.org/SSSD.sssd/newcomers/getting_started.html#github-workflow
you can read:
"SSSD is hosted on pagure.io but the development happens on GitHub."

PRs are possible on pagure and GitHub.
Which stance should be fixed in which way?

Thank you for your help.

Comments

---

Comment from lslebodn at 2017-10-23 07:14:59

It can be confusing but it is not wrong.
I found a contradiction in the documentation. At:
https://docs.pagure.org/SSSD.sssd/developers/contribute.html#source-code-repository

You can read:
"For the SSSD project, we use the Git source control system.
https://pagure.io/SSSD/sssd.git
We also maintain a read-only mirror on github."

Referential git + issue tracker is on pagure. issues are disabled on github.
pagure git is mirrored to github

However, at:
https://docs.pagure.org/SSSD.sssd/newcomers/getting_started.html#github-workflow
you can read:
"SSSD is hosted on pagure.io but the development happens on GitHub."

Yes, most developers use pull requests on github. But we also merged, manually applied pull requests from pagure:
https://pagure.io/SSSD/sssd/pull-requests?status=0

---

Comment from lslebodn at 2017-10-23 07:16:40

At:
https://docs.pagure.org/SSSD.sssd/users/faq.html#tracking-bugs-and-enhancement-requests
https://docs.pagure.org/SSSD.sssd/developers/contribute.html#tasks-for-newcomers
you can read about "Trac".
Is it OK to replace the word with "issue tracker"?

it is a relict from wiki conversion to reStructuredText(rst).
Thank you very much for checking documetation.

---

Comment from sobek at 2017-10-23 22:45:01

you are welcome, thank you for your help :)

I propose to use:

Referential git + issue tracker is on pagure. issues are disabled on github.
pagure git is mirrored to github
and "use either pagure or GitHub for creating pull requests" as the main message.

In order to minimize the confusion I would like to put this information at:
https://docs.pagure.org/SSSD.sssd/developers/contribute.html#source-code-repository
and link to it at:
https://docs.pagure.org/SSSD.sssd/newcomers/getting_started.html#github-workflow
and reword to "Assuming you use GitHub these are the steps: ...".

I will wait some more days before starting the rewrite.

---

Comment from jhrozek at 2017-10-24 10:24:33

In the old wiki we also had https://gitlab.com/fidencio/sssd-docs-backup/blob/master/GithubWorkflow.rst

If you are planning to contribute to our documentation, that would be really awesome, but would you consider also merging the information from the old wiki?

---

Comment from sobek at 2017-10-24 23:09:55

I will merge the information.

---

Comment from sobek at 2017-10-29 23:34:26

https://pagure.io/SSSD/docs/pull-request/54 has been created.

---

Comment from jhrozek at 2018-03-15 11:41:44

Since the docs PR had been closed, I'm also closing this ticket.

---

Comment from jhrozek at 2018-03-15 11:41:53

Metadata Update from @jhrozek:

• Issue close_status updated to: Fixed
• Issue status updated to: Closed (was: Open)