Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Gateway Docs] Replace References to AppGateServer with PATH #945

Merged
merged 13 commits into from
Dec 11, 2024

Conversation

red-0ne
Copy link
Contributor

@red-0ne red-0ne commented Nov 21, 2024

Summary

  • Update all Gateway AppGateServer references with PATH
  • Adapt documentation to suit PATH workflow.

Issue

AppGateServer must be deprecated and replaced by the PATH Gateway

Type of change

Select one or more from the following:

Testing

  • Documentation: make docusaurus_start; only needed if you make doc changes

Sanity Checklist

  • I have tested my changes using the available tooling
  • I have commented my code
  • I have performed a self-review of my own code; both comments & source code
  • I create and reference any new tickets, if applicable
  • I have left TODOs throughout the codebase, if applicable

@red-0ne red-0ne added documentation Improvements or additions to documentation gateway Changes related to the Gateway actor labels Nov 21, 2024
@red-0ne red-0ne added this to the Shannon Beta TestNet Launch milestone Nov 21, 2024
@red-0ne red-0ne self-assigned this Nov 21, 2024
@red-0ne red-0ne force-pushed the docs/appgate-to-path branch from 2254304 to bcbe8ca Compare November 27, 2024 17:35
@red-0ne red-0ne marked this pull request as ready for review November 27, 2024 18:39
@red-0ne red-0ne requested review from Olshansk and okdas November 27, 2024 18:40
@adshmh adshmh self-requested a review December 2, 2024 22:00
@Olshansk Olshansk changed the title [Docs] Replace AppGate Server with PATH Gateway [Gateway Docs] Replace References to AppGateServer with PATH Dec 4, 2024
Copy link
Member

@Olshansk Olshansk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@red-0ne A few minor NITs + we need a response from @okdas on this:

Screenshot 2024-12-06 at 3 26 42 PM

Should be g2g after.

@red-0ne red-0ne requested a review from Olshansk December 9, 2024 16:43
Copy link

gitguardian bot commented Dec 10, 2024

⚠️ GitGuardian has uncovered 3 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
14150880 Triggered Generic High Entropy Secret 5ebee56 localnet/kubernetes/config-path-3.yaml View secret
14150881 Triggered Generic High Entropy Secret 5ebee56 localnet/kubernetes/config-path-2.yaml View secret
13506804 Triggered Generic High Entropy Secret 5ebee56 localnet/kubernetes/config-path-1.yaml View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secrets safely. Learn here the best practices.
  3. Revoke and rotate these secrets.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Copy link
Member

@Olshansk Olshansk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's merge it in!

@red-0ne red-0ne merged commit 471ba91 into main Dec 11, 2024
13 checks passed
red-0ne added a commit that referenced this pull request Dec 11, 2024
…heet (#982)

## Summary

Adapt docker-compose walkthrough and cheatsheet to use PATH instead of
AppGate.
This is a follow-up to AppGate-to-Path documentation PR #945 

It will be applicable once
pokt-network/poktroll-docker-compose-example#31
is merged.

## Issue

AppGate Server deprecation and removal requires documentation update to
use PATH Gateway instead.


## Type of change

Select one or more from the following:

- [ ] New feature, functionality or library
- [ ] Consensus breaking; add the `consensus-breaking` label if so. See
#791 for details
- [ ] Bug fix
- [ ] Code health or cleanup
- [x] Documentation
- [ ] Other (specify)

## Testing

- [x] **Documentation**: `make docusaurus_start`; only needed if you
make doc changes

## Sanity Checklist

- [x] I have tested my changes using the available tooling
- [ ] I have commented my code
- [x] I have performed a self-review of my own code; both comments &
source code
- [ ] I create and reference any new tickets, if applicable
- [ ] I have left TODOs throughout the codebase, if applicable

---------

Co-authored-by: Daniel Olshansky <olshansky.daniel@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation gateway Changes related to the Gateway actor
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants