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.

Sign up for GitHub

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

Jump to bottom

Make documentation up to date #972

Closed
Zlopez opened this issue Oct 8, 2020 · 0 comments · Fixed by #1007
Closed

Make documentation up to date #972

Zlopez opened this issue Oct 8, 2020 · 0 comments · Fixed by #1007
Labels
docs technical debt
Milestone
1.0

Comments

@Zlopez
Copy link
Contributor

Zlopez commented Oct 8, 2020

Because of the version 1.0 at the door we should update the documentation to reflect the current state of project.
@Zlopez Zlopez added this to the 1.0 milestone Oct 8, 2020
Zlopez added a commit to Zlopez/anitya that referenced this issue Jan 14, 2021
@Zlopez
Update documentation
3bb2a42 
This commit rewrites the whole documentation to be more
up to date with current state of Anitya.
Following is the detailed list what was done:

* Rewrite user guide - describe use cases for users
                     - describe available fields in each use case
* Add admin user guide - guide for users with admin rights
* Rewrite admin guide - the deployment method was tested and the text
                        updated to work
* Update contributing guide - add how to test in staging before release
                            - update python env setup
                            - update vagrant env setup
* Move integration with Anitya to separate file - add info about fedora
                                                  messaging
                                                - list fedora messaging
                                                  topics
* Add guide for token generation to API documentation

Closes fedora-infra#972
Closes fedora-infra#803
Closes fedora-infra#798
Closes fedora-infra#748
Closes fedora-infra#453

Signed-off-by: Michal Konečný <[email protected]>
@Zlopez Zlopez mentioned this issue Jan 14, 2021
Merged
Zlopez added a commit that referenced this issue Jan 14, 2021
@Zlopez
Update documentation
d22a524 
This commit rewrites the whole documentation to be more
up to date with current state of Anitya.
Following is the detailed list what was done:

* Rewrite user guide - describe use cases for users
                     - describe available fields in each use case
* Add admin user guide - guide for users with admin rights
* Rewrite admin guide - the deployment method was tested and the text
                        updated to work
* Update contributing guide - add how to test in staging before release
                            - update python env setup
                            - update vagrant env setup
* Move integration with Anitya to separate file - add info about fedora
                                                  messaging
                                                - list fedora messaging
                                                  topics
* Add guide for token generation to API documentation

Closes #972
Closes #803
Closes #798
Closes #748
Closes #453

Signed-off-by: Michal Konečný <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs technical debt
Projects
None yet
Milestone
1.0
Development

Successfully merging a pull request may close this issue.

Update documentation Zlopez/anitya
1 participant
@Zlopez