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

ngclient: Proper public module documentation #1385

Closed
jku opened this issue May 12, 2021 · 3 comments · Fixed by #1474
Closed

ngclient: Proper public module documentation #1385

jku opened this issue May 12, 2021 · 3 comments · Fixed by #1474
Assignees
@jku
Labels
documentation Documentation of the project as well as procedural documentation ngclient
Milestone
Sprint 4

Comments

@jku
Copy link
Member

jku commented May 12, 2021

New client should have good public module/class documentation for Updater: currently it's a bit patchy.

Plan is to get the new client merged to develop (as alternative client, not replacing the current one): this issue can be solved after merge.
@jku jku added the experimental-client Items related to the development of a new client (see milestone/8 and theexperimental-client branch) label May 12, 2021
@jku jku mentioned this issue May 12, 2021
Merged
@jku
Copy link
Member Author

jku commented May 12, 2021 •
edited
Loading

A specific improvement is reviewing and documenting what target_path really is and how it works (that it's target identifier but also a relative local filesystem path and a url fragment).

@joshuagl joshuagl added this to the Client Refactor milestone May 12, 2021
@joshuagl
Copy link
Member

It would be great if this documentation was publishable/published on readthedocs.io, like the in-toto docs https://in-toto.readthedocs.io/en/latest/

Note: There's some previous discussion on TARGETPATH here #462

@jku
Copy link
Member Author

jku commented May 12, 2021

Documenting also my recent realization on target_path: the spec does not require target_path to be a usable relative local filesystem path (and it can't really -- this requires assumptions on the filesystem). Using target_path as a relative local filesystem path is just how both the reference repository tools and the reference client have decided to implement it.

@sechkova sechkova added the documentation Documentation of the project as well as procedural documentation label May 18, 2021
@jku jku added ngclient and removed experimental-client Items related to the development of a new client (see milestone/8 and theexperimental-client branch) labels May 21, 2021
@sechkova sechkova mentioned this issue May 21, 2021
Merged
@jku jku changed the title experimental client: Proper public module documentation ngclient: Proper public module documentation May 25, 2021
@sechkova sechkova added the backlog Issues to address with priority for current development goals label May 26, 2021
@joshuagl joshuagl removed this from the weeks22-23 milestone Jun 9, 2021
@sechkova sechkova added this to the weeks26-27 milestone Jun 23, 2021
jku pushed a commit to jku/python-tuf that referenced this issue Jul 1, 2021
ngclient: Add module documentation
6494f27 
* Added module docs and a simple example
* Experimented with sphinx linking for classes and methods
  (it's pretty ugly in source format)
* Small improvements in the methods docs

Fixes theupdateframework#1385

Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
jku pushed a commit to jku/python-tuf that referenced this issue Jul 1, 2021
ngclient: Add module documentation
adadf18 
* Added module docs and a simple example
* Experimented with sphinx linking for classes and methods
  (it's pretty ugly in source format)
* Small improvements in the methods docs

Fixes theupdateframework#1385

Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
jku pushed a commit to jku/python-tuf that referenced this issue Jul 5, 2021
ngclient: Add module documentation
58221cd 
* Added module docs and a simple example
* Experimented with sphinx linking for classes and methods
  (it's pretty ugly in source format)
* Small improvements in the methods docs

Fixes theupdateframework#1385

Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
jku pushed a commit to jku/python-tuf that referenced this issue Jul 5, 2021
ngclient: Add module documentation
0c85e43 
* Added module docs and a simple example
* Experimented with sphinx linking for classes and methods
  (it's pretty ugly in source format)
* Small improvements in the methods docs

Fixes theupdateframework#1385

Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
@joshuagl joshuagl linked a pull request Jul 7, 2021 that will close this issue
Document ngclient #1474
Merged
@joshuagl joshuagl modified the milestones: weeks26-27, Sprint 4 Jul 7, 2021
@joshuagl joshuagl removed the backlog Issues to address with priority for current development goals label Jul 7, 2021
jku pushed a commit to jku/python-tuf that referenced this issue Jul 19, 2021
ngclient: Add module documentation
c37d21d 
* Added module docs and a simple example
* Experimented with sphinx linking for classes and methods
  (it's pretty ugly in source format)
* Small improvements in the methods docs

Fixes theupdateframework#1385

Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jku jku

Labels
documentation Documentation of the project as well as procedural documentation ngclient
Projects
None yet
Milestone
Sprint 4
Development

Successfully merging a pull request may close this issue.

Document ngclient jku/python-tuf
3 participants
@jku @joshuagl @sechkova