Commit graph

301 commits

Author SHA1 Message Date
lukpueh
c5dac3136d Revert "Minor tutorial related tweaks made after reviewing PR #775"
- line-wraps are integrated with
190a736d297ef5d8d3c1e8761ac196666954f3a2 in #775
- sorting the value returned by `get_dirty_roles()` in
`dirty_roles()` is not necessary as `get_dirty_roles()` already
returns a sorted list per ac010337f0e154f9c183f8abe759ce26ed16731c
in #775.

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2019-11-29 12:35:28 +01:00
Joshua Lock
282c9aa98b TUTORIAL: minor cleanup
An attempt to make part of the tutorial less jarring, and reformatting
of the surrounding text to keep the lines <80 characters.

Signed-off-by: Joshua Lock <jlock@vmware.com>
2019-11-28 22:01:33 +00:00
Lukas Puehringer
733c2edfe0 CHANGELOG: Add v0.12.1 entry
Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2019-11-14 15:49:10 +01:00
Justin Cappos
f6bd46fc13 Governance clarifications
Signed-off-by: Justin Cappos <justincappos@gmail.com>
Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2019-11-11 15:51:52 +01:00
Justin Cappos
1f2df57ecd
Update docs/GOVERNANCE.md
Signed-off-by: Justin Cappos <justincappos@gmail.com>

Co-Authored-By: Trishank K Kuppusamy <33133073+trishankatdatadog@users.noreply.github.com>
2019-11-05 15:32:29 -05:00
Justin Cappos
35b97a1951
Update docs/GOVERNANCE.md
Signed-off-by: Justin Cappos <justincappos@gmail.com>

Co-Authored-By: Lois Anne DeLong <lad278@nyu.edu>
2019-11-05 15:25:36 -05:00
Justin Cappos
01b90c4245
Update docs/GOVERNANCE.md
Signed-off-by: Justin Cappos <justincappos@gmail.com>

Co-Authored-By: Lois Anne DeLong <lad278@nyu.edu>
2019-11-05 15:25:11 -05:00
Justin Cappos
7753af072c
Update docs/GOVERNANCE.md
Signed-off-by: Justin Cappos <justincappos@gmail.com>

Co-Authored-By: Lois Anne DeLong <lad278@nyu.edu>
2019-11-05 15:25:00 -05:00
Justin Cappos
6a13894fb5
CB term information
Signed-off-by: Justin Cappos <justincappos@gmail.com>
2019-11-05 13:28:11 -05:00
Justin Cappos
991b4f3ee3
Merge pull request #947 from theupdateframework/JustinCappos-CB-clarify+DCO
CB clarifications requested by Liz
2019-11-05 10:42:19 -05:00
Trishank K Kuppusamy
f067ff9e3e
Update MAINTAINERS.txt 2019-11-05 09:56:28 -05:00
Trishank K Kuppusamy
ccd8904a1e
Update MAINTAINERS.txt 2019-11-05 09:55:17 -05:00
Justin Cappos
bab230ff32
CB clarifications requested by Liz
Signed-off-by: Justin Cappos <justincappos@gmail.com>
2019-11-05 09:00:35 -05:00
Justin Cappos
3973e79b87
changes recommended by Liz
Signed-off-by: Justin Cappos  <justincappos@gmail.com>
2019-10-30 06:31:33 -04:00
Justin Cappos
2ad18feb27
quorum on CB
Signed-off-by: Justin Cappos <justincappos@gmail.com>
Signed-off-by: Santiago Torres <santiago@nyu.edu>
2019-10-16 11:52:12 -04:00
Lukas Puehringer
3b77a7d320 CHANGELOG: Add 0.12.0 entry
Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2019-10-14 16:47:16 +02:00
Lukas Puehringer
42a4cee56c Add slow retrieval disclaimer
Since https://github.com/theupdateframework/tuf/pull/781 we
only provide limited protection against slow retrieval attacks.
So far this has only been discussed in above issue and hinted at
by a disabled test and a code comment in that test.

This change adds a corresponding disclaimer to a more prominent
place, i.e. the list of attacks in SECURITY.md.

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
Co-Authored-By: Trishank K Kuppusamy <33133073+trishankatdatadog@users.noreply.github.com>
2019-10-10 16:43:46 +02:00
lukpueh
f79ee33501
Merge pull request #915 from lukpueh/tox-with-sslib-master
Add sslib master tox build + flesh out test docs
2019-09-18 10:28:05 +02:00
Lukas Puehringer
86257f2729 Add extra installation instruction to contrib doc
Add hint to install `coverage` before using it.

This should be installed via dev-requirements.txt, however it
does not seem to fit in there, because dev-requirements.txt pins
all its dependencies which does not seem to make sense for a
development tool.

Maybe a hierarchy of requirements.txt similar to
06a28987dc
could be established.

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2019-09-18 10:21:53 +02:00
Lukas Puehringer
593490dd7d Add sslib master tox build + flesh out test docs
Add a tox build that runs tests against securesystemslib's tip of
development, i.e. master branch, to ease preparation of tuf for a
new securesystmeslib release.

The tox build is run on travis but is allowed to fail.

This commit also fleshes out the testing section of the
contribution documentation.

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2019-09-16 19:04:16 +02:00
Lukas Puehringer
94d1c51611 Update link to historical tuf-spec.0.9.txt
Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2019-09-16 15:43:39 +02:00
Lukas Puehringer
a799a69494 Update docs/MAINTAINERS.txt
- Remove alumni @vladimir-v-diaz
- Add @SantiagoTorres and Marina (@@mnm678)

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2019-07-16 12:00:18 +02:00
Sebastien Awwad
56a2928952
DOC: move full install instructions to INSTALLATION.rst
and note that if errors occur while installing the optional
crypto dependencies, that the non-Python dependencies section
should be consulted.

Also adds a git clone step to the development installation
instructions in the contributors' instructions, and other
minor installation notes for contributors.

Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
2019-04-08 17:13:11 -04:00
Sebastien Awwad
67dd649680
DOC: cover possible environment requirements in QUICKSTART
Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
2019-04-08 15:21:52 -04:00
Sebastien Awwad
2af4d3f12e
DOC: simplify installation instructions in QUICKSTART
Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
2019-04-08 13:32:43 -04:00
Sebastien Awwad
ed6acd4ef1
minor DOC: label the advanced tutorial as such
Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
2019-04-08 11:56:45 -04:00
Sebastien Awwad
1f3e5b6483
DOC: collapse CLI_EXAMPLES.md into CLI.md
Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
2019-04-08 11:54:10 -04:00
Sebastien Awwad
5a94d5db3e
minor DOC: fix unfinished sentence, some punctuation
in the QUICKSTARD.md

Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
2019-04-08 11:49:25 -04:00
Sebastien Awwad
907186e6a4
DOC: revise quickstart and reorganize tutorials:
- correctly frame the CLI's current state as a tutorial toy.
- provide a friendlier quickstart that puts what it's doing into
  perspective and guides you to next steps.
- provide a better sense of what each tutorial/quickstart doc is
  for.
- make the getting started page slightly more friendly.

Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
2019-04-05 13:44:07 -04:00
Sebastien Awwad
a4cf9c95c2
Merge pull request #833 from theupdateframework/roadmap_corrections
DOC: Update the outdated ROADMAP.md
2019-03-28 15:29:11 -04:00
Sebastien Awwad
24618a956b
DOC: Clarify repository_tool interface to delegated roles
Add note to make clear what was implicit: that once a delegated role is created,
it can be accessed (for the same purposes as you'd access the Targets role
using `repository.targets`) as: `repository.targets("<delegated rolename>")`.

Also add that specific note to the add_targets section of the tutorial.
2019-03-25 10:47:11 -04:00
Sebastien Awwad
e541d05f08
DOC: Note client dir creation in CLI instructions
Note that the `repo.py --init` call also sets up a client directory.

A student recently ran into some confusion on this point, and it's not properly documented here.
2019-03-11 10:31:24 -04:00
Sebastien Awwad
e97b0b091d
Merge pull request #824 from HavardLine/patch-1
Context to QUICKSTART.md
2019-02-26 12:51:11 -05:00
Sebastien Awwad
4847783001
DOC: Update the outdated ROADMAP.md
- refer to the authoritative sources for the latest releases
- include new packager information
- add tasks for upcoming releases
- generalize release schedule

Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
2019-02-26 11:22:47 -05:00
Vu Cong Tuan
0d58fae3a8 Update deprecated links in docs
Signed-off-by: Vu Cong Tuan <tuanvc@vn.fujitsu.com>
2019-02-26 08:58:59 +07:00
Vu Cong Tuan
bc50deb865 Fix some typos in docs
Signed-off-by: Vu Cong Tuan <tuanvc@vn.fujitsu.com>
2019-02-25 17:00:26 +07:00
Nguyen Quang Huy
4ad02f45ff Add signoff to commit
By the site support certification, so need update http to https url

Signed-off-by: Nguyen Quang Huy <huynq0911@gmail.com>
2019-02-22 09:08:52 +07:00
Nguyen Quang Huy
6a4d222df5 Update deprecated url
Update deprecated url to new url

Signed-off-by: Nguyen Quang Huy <huynq0911@gmail.com>
2019-02-21 16:50:19 +07:00
lukpueh
c3e28e7082
Merge pull request #827 from huynq0911/fix_some_typos
Fix some typos
2019-02-21 09:56:48 +01:00
huynq0911
3772ed3d2d Fix some typos
Correct some words spelling for reading more easily.

Signed-off-by: huynq0911 <huynq0911@gmail.com>
2019-02-21 00:02:24 +07:00
huynq0911
4af9cf5899 Change http to https for security links
For security, we should change http into https links.

Signed-off-by: huynq0911 <huynq0911@gmail.com>
2019-02-20 23:47:26 +07:00
Havard
7cc150af40 Context to QUICKSTART.md
Hi, I did the quick-start today and missed some context. This is my suggestion.

Thanks for a cool framework!
Regards Håvard

Signed-off-by: Håvard B Line <havard.line@gmail.com>
2019-02-17 20:05:38 +01:00
Justin Cappos
7e0c4cc29f
Update ADOPTERS.md 2018-10-16 15:10:06 -04:00
Justin Cappos
5d58ea7a81
Explaining GOVERNANCE structure to better match CNCF graduation ask 2018-10-11 10:50:47 -04:00
Vladimir Diaz
3c04c15150
Remove the notes about the doc being a work in progress in CLI.md and CLI_EXAMPLES.md
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-28 17:36:03 -04:00
Vladimir Diaz
dc63c07f42
Update GETTING_STARTED.rst
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-28 17:30:16 -04:00
Vladimir Diaz
8b42ea07d7
Update CLI_EXAMPLES.md with change to client.py and UnknownTargetError
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-28 12:56:53 -04:00
Vladimir Diaz
02d9980b10
Minor edits to text in CLI.md and CLI_EXAMPLES.md
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-28 12:14:40 -04:00
Vladimir Diaz
6bf8a95a71
Minor edits to relocate text and introduction
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 14:48:31 -04:00
Vladimir Diaz
3d88d8bde1
Remove obsolete text in the 'Clean' section of CLI.md
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 14:31:00 -04:00