start fork: portable-rustls (0.0.1-dev) with doc TODOs

.github/workflows/build.yml

@@ -113,8 +113,8 @@ jobs:
       - name: cargo test (debug; rustls-provider-test; all features)
         run: cargo test --all-features -p rustls-provider-test
 
-      - name: cargo package --all-features -p rustls
-        run: cargo package --all-features -p rustls
+      - name: cargo package --all-features -p portable-rustls
+        run: cargo package --all-features -p portable-rustls
 
   msrv:
     name: MSRV
@@ -130,13 +130,13 @@ jobs:
           toolchain: "1.71"
 
       # zlib-rs is optional and requires a later MSRV
-      - run: cargo check --locked --lib $(admin/all-features-except zlib rustls) -p rustls
+      - run: cargo check --locked --lib $(admin/all-features-except zlib rustls) -p portable-rustls
 
       - uses: dtolnay/rust-toolchain@master
         with:
           toolchain: "1.75"
 
-      - run: cargo check --locked --lib --all-features -p rustls
+      - run: cargo check --locked --lib --all-features -p portable-rustls
 
   features:
     name: Features
@@ -295,7 +295,7 @@ jobs:
         uses: dtolnay/rust-toolchain@nightly
 
       - name: cargo doc (rustls; all features)
-        run: cargo doc --locked --all-features --no-deps --document-private-items --package rustls
+        run: cargo doc --locked --all-features --no-deps --document-private-items --package portable-rustls
         env:
           RUSTDOCFLAGS: -Dwarnings
 
@@ -389,8 +389,8 @@ jobs:
         run: cargo install cross --git https://github.com/cross-rs/cross
       - name: Install bindgen feature & CLI for aws-lc-sys (as needed for many cross targets)
         if: ${{ matrix.target != 'i686-unknown-linux-gnu' }}
-        run: cargo add --dev --features bindgen 'aws-lc-sys@>0.20' --package rustls --verbose && cargo install bindgen-cli --verbose
-      - run: cross test --package rustls --target ${{ matrix.target }}
+        run: cargo add --dev --features bindgen 'aws-lc-sys@>0.20' --package portable-rustls --verbose && cargo install bindgen-cli --verbose
+      - run: cross test --package portable-rustls --target ${{ matrix.target }}
 
   semver:
     name: Check semver compatibility
@@ -468,7 +468,7 @@ jobs:
       #   is only intended for the main `rustls` crate.
       - run: ./admin/clippy -- --deny warnings --allow clippy::disallowed_types
       # - Keep the main crate free of all warnings.
-      - run: cargo clippy -p rustls -- --deny warnings
+      - run: cargo clippy -p portable-rustls -- --deny warnings
 
   clippy-nightly:
     name: Clippy (Nightly)
@@ -492,7 +492,7 @@ jobs:
       #   is only intended for main `rustls` crate.
       - run: ./admin/clippy -- --allow clippy::disallowed_types
       # Check the main crate for any Clippy nightly warnings, but do not deny them.
-      - run: cargo clippy -p rustls
+      - run: cargo clippy -p portable-rustls
 
   check-external-types:
     name: Validate external types appearing in public API

.github/workflows/docs.yml

@@ -6,8 +6,9 @@ permissions:
 on:
   workflow_dispatch:
   push:
-    branches:
-      - main
+    # GONE FROM THIS FORK:
+    # branches:
+    #   - main
   schedule:
     - cron: '0 18 * * *'
 
@@ -24,10 +25,9 @@ jobs:
       - name: Install rust toolchain
         uses: dtolnay/rust-toolchain@nightly
 
-      - name: Install zola
-        uses: taiki-e/install-action@v2
-        with:
-          tool: [email protected]
+      # GONE FROM THIS FORK:
+      # - name: Install zola
+      # ...
 
       - name: Generate version information
         run: |
@@ -39,49 +39,18 @@ jobs:
 
       - name: cargo doc
         # keep features in sync with Cargo.toml `[package.metadata.docs.rs]` section
-        run: cargo doc --locked --features read_buf,ring --no-deps --package rustls
+        run: cargo doc --locked --features read_buf,ring --no-deps --package portable-rustls
         env:
           RUSTDOCFLAGS: -Dwarnings --cfg=docsrs --html-after-content tag.html
 
-      - name: Generate other pages
-        run: |
-          cd website && zola build --output-dir ../target/website/
-
-      - name: Restore lychee cache
-        uses: actions/cache@v4
-        with:
-          path: .lycheecache
-          key: cache-lychee-${{ github.sha }}
-          restore-keys: cache-lychee-
-
-      - name: Check links
-        uses: lycheeverse/lychee-action@v2
-        with:
-          args: >
-            --accept 200..=204,403,429,500
-            --cache
-            --max-cache-age 1d
-            --exclude-path 'website/content/'
-            '**/*.md'
-            'target/doc/**/*.html'
-          fail: true
-
-      - name: Massage rustdoc output
-        run: |
-          # lockfile causes deployment step to go wrong, due to permissions
-          rm -f target/doc/.lock
-          # move the result into website root
-          mv target/doc/rustls target/website/docs
-
-      - name: Package and upload artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: ./target/website/
+      # GONE FROM THIS FORK: Generate other pages for website (etc.)
 
   deploy:
     name: Deploy
     runs-on: ubuntu-latest
-    if: github.repository == 'rustls/rustls'
+    # SKIP IN THIS FORK
+    # if: github.repository == 'rustls/rustls'
+    if: false
     needs: generate
     permissions:
       pages: write

BENCHMARKING.md

@@ -1,5 +1,7 @@
 # Benchmarking
 
+<!-- TODO(portable-rustls) UPDATE INFO BELOW AS MAY BE NEEDED FOR THIS FORK -->
+
 This repository includes benchmarks for multiple use cases. They are described below, along with
 information on how to run them.
 

CHANGELOG.md

@@ -1,4 +1,9 @@
 # Changelog
 
+<!-- TODO(portable-rustls) UPDATE INFO FOR THIS FORK -->
+TODO
+
+<!-- TODO(portable-rustls) UPDATE INFO FOR THIS FORK:
 The detailed list of changes in each release can be found at
 https://github.com/rustls/rustls/releases.
+-- -->

CODE_OF_CONDUCT.md

@@ -1,5 +1,11 @@
 # Code of conduct
 
+<!-- TODO(portable-rustls) UPDATE INFO BELOW FOR THIS FORK -->
+
 This project adopts the [Rust Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct).
+<!-- TODO(portable-rustls) UPDATE INFO FOR THIS FORK:
 Please email [email protected] to report any instance of misconduct, or if you
 have any comments or questions on the Code of Conduct.
+-- -->
+<!-- TODO(portable-rustls) CLEANUP & UPDATE WITH MORE SPECIFIC INFO FOR THIS FORK: -->
+PLEASE REPORT PRIVATELY TO A MAINTAINER OF THIS FORK IN CASE OF ANY QUESTIONS, COMMENTS, OR POSSIBLE MISCONDUCT.

CONTRIBUTING.md

@@ -1,5 +1,7 @@
 # Contributing
 
+<!-- TODO(portable-rustls) UPDATE INFO BELOW FOR THIS FORK -->
+
 Thanks for considering helping this project.  There are many
 ways you can help: using the library and reporting bugs,
 reporting usability issues, making additions and improvements
@@ -13,10 +15,13 @@ a pcap or reproduction steps.
 
 Feel free to file github issues to get help, or ask a question.
 
+<!-- TODO(portable-rustls) CLEANUP & UPDATE WITH MORE SPECIFIC INFO FOR THIS FORK: -->
 If you believe you've found a security bug please
-[open a draft security advisory](https://github.com/rustls/rustls/security/advisories/new)
-in GitHub, and not as a regular repository issue. See [SECURITY.md] for more
-information.
+- IF SPECIFIC TO THIS FORK: REPORT PRIVATELY TO A MAINTAINER OF THIS FORK, NOT VIA PUBLIC GITHUB ISSUE, DISCUSSION or PR.
+- FOR `rustls` IN GENERAL: [open a draft security advisory on `rustls` in GitHub](https://github.com/rustls/rustls/security/advisories/new) ... NOT AS A REGULAR REPOSITORY ISSUE
+
+<!-- TODO(portable-rustls) CLEANUP FOR THIS FORK -->
+SEE [SECURITY.md] FOR MORE INFORMATION.
 
 [SECURITY.md]: SECURITY.md
 
@@ -48,8 +53,10 @@ Our default workflow is to rebase clean commit history from a PR to `main`.
 
 ## Security bugs
 
-Please report security bugs by [opening a draft security advisory](https://github.com/rustls/rustls/security/advisories/new)
-in GitHub, and not as a regular repository issue.
+<!-- TODO(portable-rustls) CLEANUP & UPDATE WITH MORE SPECIFIC INFO FOR THIS FORK: -->
+AS STATED ABOVE:
+- IF SPECIFIC TO THIS FORK: REPORT PRIVATELY TO A MAINTAINER OF THIS FORK, NOT VIA PUBLIC GITHUB ISSUE, DISCUSSION or PR.
+- FOR `rustls` IN GENERAL: [open a draft security advisory on `rustls` in GitHub](https://github.com/rustls/rustls/security/advisories/new) ... NOT AS A REGULAR REPOSITORY ISSUE
 
 See [SECURITY.md] for more information.
 
@@ -467,4 +474,5 @@ assist code reviewers of end-user code.
 
 ## Licensing
 
+<!-- TODO(portable-rustls) UPDATE INFO HERE & IN LICENSE FILES AS MAY BE NEEDED FOR THIS FORK: -->
 Contributions are made under [rustls's licenses](LICENSE).