Skip to content

Commit fa15eea

Browse files
authored
Merge pull request #1776 from kairoaraujo/issue#1739/relative_links_404
docs: fix relative to absolute links on README.md
2 parents 2b0776c + 0a4d88a commit fa15eea

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
----------------------------
1010
*__IMPORTANT NOTICE:__ A stable 1.0.0 release of the modern implementation only
1111
is scheduled for January 2022. Please see the [*1.0.0
12-
announcement*](docs/1.0.0-ANNOUNCEMENT.md) page for more details about the release
13-
and the deprecation of the legacy implementation, including migration
14-
instructions.*
12+
announcement*](https://github.com/theupdateframework/python-tuf/blob/develop/docs/1.0.0-ANNOUNCEMENT.md)
13+
page for more details about the release and the deprecation of the legacy
14+
implementation, including migration instructions.*
1515

1616
----------------------------
1717
This repository is the **reference implementation** of
@@ -28,13 +28,13 @@ Python-TUF provides two APIs:
2828

2929
High-level support for implementing
3030
[repository operations](https://theupdateframework.github.io/specification/latest/#repository-operations)
31-
is planned but not yet provided: see [1.0.0 plans](docs/1.0.0-ANNOUNCEMENT.md).
31+
is planned but not yet provided: see [1.0.0 plans](https://github.com/theupdateframework/python-tuf/blob/develop/docs/1.0.0-ANNOUNCEMENT.md).
3232

3333
In addition to these APIs the project also provides a *legacy
3434
implementation* with `tuf.client` implementing the client workflow and
3535
`tuf.repository_tool` providing a high-level interface for repository
3636
operations. The legacy implementation is going to be
37-
[deprecated](docs/1.0.0-ANNOUNCEMENT.md) in the near future.
37+
[deprecated](https://github.com/theupdateframework/python-tuf/blob/develop/docs/1.0.0-ANNOUNCEMENT.md) in the near future.
3838

3939
The reference implementation strives to be a readable guide and demonstration
4040
for those working on implementing TUF in their own languages, environments, or
@@ -65,11 +65,13 @@ Documentation
6565
-------------
6666
* [Introduction to TUF's Design](https://theupdateframework.io/overview/)
6767
* [The TUF Specification](https://theupdateframework.github.io/specification/latest/)
68-
* Examples: [client](examples/client_example) and [repository](examples/repo_example)
68+
* Examples: [client](https://github.com/theupdateframework/python-tuf/tree/develop/examples/client_example)
69+
and [repository](https://github.com/theupdateframework/python-tuf/tree/develop/examples/repo_example)
6970
* [API Reference](https://theupdateframework.readthedocs.io/)
70-
* [Governance](docs/GOVERNANCE.md) and [Maintainers](docs/MAINTAINERS.txt)
71+
* [Governance](https://github.com/theupdateframework/python-tuf/blob/develop/docs/GOVERNANCE.md)
72+
and [Maintainers](https://github.com/theupdateframework/python-tuf/blob/develop/docs/MAINTAINERS.txt)
7173
for the reference implementation
72-
* [Miscellaneous Docs](docs/)
74+
* [Miscellaneous Docs](https://github.com/theupdateframework/python-tuf/tree/develop/docs)
7375

7476

7577
Contact
@@ -100,7 +102,9 @@ PGP key fingerprint **E9C0 59EC 0D32 64FA B35F 94AD 465B F9F6 F8EB 475A**.
100102
Please do not use the GitHub issue tracker to submit vulnerability reports.
101103
The issue tracker is intended for bug reports and to make feature requests.
102104
Major feature requests, such as design changes to the specification, should
103-
be proposed via a [TUF Augmentation Proposal](docs/TAP.rst) (TAP).
105+
be proposed via a
106+
[TUF Augmentation Proposal](https://theupdateframework.github.io/specification/latest/#tuf-augmentation-proposal-tap-support)
107+
(TAP).
104108

105109
Limitations
106110
-----------
@@ -113,7 +117,8 @@ License
113117

114118
This work is [dual-licensed](https://en.wikipedia.org/wiki/Multi-licensing) and
115119
distributed under the (1) MIT License and (2) Apache License, Version 2.0.
116-
Please see [LICENSE-MIT](LICENSE-MIT) and [LICENSE](LICENSE).
120+
Please see [LICENSE-MIT](https://github.com/theupdateframework/python-tuf/blob/develop/LICENSE-MIT)
121+
and [LICENSE](https://github.com/theupdateframework/python-tuf/blob/develop/LICENSE).
117122

118123

119124
Acknowledgements

0 commit comments

Comments
 (0)