Commit graph

281 commits

Author SHA1 Message Date
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
Vladimir Diaz
d3c0852495
Outline the steps for the second example
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 14:30:16 -04:00
Vladimir Diaz
bccba83f96
Add introductory text, rename headings, change title
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 14:15:11 -04:00
Vladimir Diaz
db7b9bd403
Include steps being follows and revise text in 'Replace a top-level key'
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 13:47:23 -04:00
Vladimir Diaz
58a00d6b8b
Add missing command to create key_x and key_x2
Add blank lines between commands to help readability

Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 13:33:19 -04:00
Vladimir Diaz
dceb6bcc9b
Rename the keys and metadata for role X and Y
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 13:22:31 -04:00
Vladimir Diaz
46a624f897
Revise 'clean' section, modify a couple headings, and minor tweaks to text
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 11:21:35 -04:00
Vladimir Diaz
b8bec7be7d
Relocate the --sign section, add line breaks, and minor revision to text
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 10:40:40 -04:00
Vladimir Diaz
473a0b0c12
Add a couple line breaks to help break apart the main text
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-26 17:21:07 -04:00
Vladimir Diaz
1c3d1ee302
Revise QUICKSTART.md to capture more of what happens in the background
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-26 17:07:33 -04:00
Vladimir Diaz
1133bb4ce4
Revise instructions in QUICKSTART.md to remove unnecessary info
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-26 13:26:38 -04:00
Vladimir Diaz
3f82734504
Revise instructions in CLI.md to remove typo and unnecessary info
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-26 13:25:50 -04:00
Vladimir Diaz
cb4b95137f
Add installation instructions to QUICKSTART.md for required dependencies
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-25 11:53:59 -04:00
Vladimir Diaz
f16784c67f
Add installation instructions to CLI.md for required dependencies
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-25 11:53:29 -04:00
Vladimir Diaz
6ae7eb42ce
Revise text to cover new password behavior of securesystemslib
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-21 15:02:19 -04:00
Vladimir Diaz
fbc02d3034
Use a working example in the overview section
Some users will actually attempt to execute the example listed in the overview section.  Use a working example that doesn't raise an error.

Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-21 11:19:59 -04:00
Vladimir Diaz
965e121148
Update text covering the client update
* The client script is now named 'client.py' and the user is no longer required to manually copy the basic_client.py to the CWD
* A log file is not saved to the CWD, by default
* The client.py script doesn't download all target files available on the repo.

Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-21 11:07:16 -04:00
Vladimir Diaz
8873b4aca9
Add latest release (v0.11.1) and link to previous releases
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-20 11:04:21 -04:00
Vladimir Diaz
48e0ecca5d
Add entry in CHANGELOG.md for v0.11.1
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-19 17:17:33 -04:00
Sebastien Awwad
c3393db29b
DOC: Typo fix in tutorial
Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
2018-06-15 14:33:42 -04:00
Vladimir Diaz
85b4a4f1a8
Check off task for silve badge and add tasks to list
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-13 13:35:38 -04:00