From 44210c350b2fda5e147efe50ec1926ddcd6ca605 Mon Sep 17 00:00:00 2001 From: yuroitaki Date: Tue, 9 Jul 2024 16:03:14 +0800 Subject: [PATCH] fix: miscellaneous fixes on documentations (#528) * fix: miscellaneous fixes on documentation, notary-server. * Revert notary changes. * Add warning when TLS is off. --- CHANGELOG.md | 7 ------- CONTRIBUTING.md | 19 ------------------- README.md | 2 +- notary/server/README.md | 2 +- notary/server/openapi.yaml | 1 - tlsn/examples/discord/README.md | 2 +- tlsn/examples/simple/README.md | 2 +- tlsn/examples/twitter/README.md | 2 +- 8 files changed, 5 insertions(+), 32 deletions(-) delete mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index ef88a6b9c9..0000000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,7 +0,0 @@ -# Changelog -All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - -## [Unreleased] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f9870649c4..725f2eee1d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,25 +16,6 @@ keywords. Try to do one pull request per change. -### Updating the changelog - -Update the changes you have made in -[CHANGELOG](CHANGELOG.md) -file under the **Unreleased** section. - -Add the changes of your pull request to one of the following subsections, -depending on the types of changes defined by -[Keep a changelog](https://keepachangelog.com/en/1.0.0/): - -- `Added` for new features. -- `Changed` for changes in existing functionality. -- `Deprecated` for soon-to-be removed features. -- `Removed` for now removed features. -- `Fixed` for any bug fixes. -- `Security` in case of vulnerabilities. - -If the required subsection does not exist yet under **Unreleased**, create it! - ## Style ### Capitalization and punctuation diff --git a/README.md b/README.md index 63f5119e64..669c596096 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ [mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg [apache-badge]: https://img.shields.io/github/license/saltstack/salt -[actions-badge]: https://github.com/tlsnotary/tlsn/actions/workflows/ci.yml/badge.svg +[actions-badge]: https://github.com/tlsnotary/tlsn/actions/workflows/ci.yml/badge.svg?branch=dev [actions-url]: https://github.com/tlsnotary/tlsn/actions?query=workflow%3Aci+branch%3Adev [Website](https://tlsnotary.org) | diff --git a/notary/server/README.md b/notary/server/README.md index a79113c085..6937fb2e4a 100644 --- a/notary/server/README.md +++ b/notary/server/README.md @@ -103,7 +103,7 @@ The main objective of a notary server is to perform notarizations together with ### Features #### Notarization Configuration To perform a notarization, some parameters need to be configured by the prover and the notary server (more details in the [OpenAPI specification](./openapi.yaml)), i.e. -- maximum transcript size +- maximum data that can be sent and received - unique session id To streamline this process, a single HTTP endpoint (`/session`) is used by both TCP and WebSocket clients. diff --git a/notary/server/openapi.yaml b/notary/server/openapi.yaml index cd0fdec48a..9d30898afc 100644 --- a/notary/server/openapi.yaml +++ b/notary/server/openapi.yaml @@ -183,7 +183,6 @@ components: type: integer required: - "clientType" - - "maxTranscriptSize" NotarizationSessionResponse: type: object properties: diff --git a/tlsn/examples/discord/README.md b/tlsn/examples/discord/README.md index 06fe86ba96..747c10c969 100644 --- a/tlsn/examples/discord/README.md +++ b/tlsn/examples/discord/README.md @@ -27,7 +27,7 @@ You can find the `CHANNEL_ID` directly in the url: `https://discord.com/channels/@me/{CHANNEL_ID)` ## Start the notary server -1. Edit the notary server [config file](../../../notary/server/config/config.yaml) to turn off TLS so that self-signed certificates can be avoided. +1. Edit the notary server [config file](../../../notary/server/config/config.yaml) to turn off TLS so that self-signed certificates can be avoided (⚠️ this is only for local development purposes — TLS must be used in production). ```yaml tls: enabled: false diff --git a/tlsn/examples/simple/README.md b/tlsn/examples/simple/README.md index b5bcd97c7b..633e4cd4cd 100644 --- a/tlsn/examples/simple/README.md +++ b/tlsn/examples/simple/README.md @@ -85,6 +85,6 @@ Feel free to try these extra challenges: ### Next steps -Try out the [Discord example](../Discord/README.md) and notarize a Discord conversations. +Try out the [Discord example](../discord/README.md) and notarize a Discord conversations. diff --git a/tlsn/examples/twitter/README.md b/tlsn/examples/twitter/README.md index 6e31d23c78..8fd28ec44e 100644 --- a/tlsn/examples/twitter/README.md +++ b/tlsn/examples/twitter/README.md @@ -26,7 +26,7 @@ Next, open the **Developer Tools**, go to the **Network** tab, and refresh the p ![Screenshot](twitter_dm_browser.png) ## Start the notary server -1. Edit the notary server [config file](../../../notary/server/config/config.yaml) to turn off TLS so that self-signed certificates can be avoided. +1. Edit the notary server [config file](../../../notary/server/config/config.yaml) to turn off TLS so that self-signed certificates can be avoided (⚠️ this is only for local development purposes — TLS must be used in production). ```yaml tls: enabled: false