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

Issue 244: Initial PR: Convert Pekko Platform Guide project files #21

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

sam-byng
Copy link

@sam-byng sam-byng commented Apr 27, 2023

This is an initial commit for issue apache/pekko#244 : rewrite pekko-platform-guide to use pekko artifacts and to remove Akka refs

  • Update repository READMEs to refer to Pekko
  • Remove Gitlab workflow involving deployment to long-life 'gustav VM' - we are not using that here
  • Update site.yml URLs to point to https://pekko.apache.org/docs/pekko-platform-guide/current
  • Update the validator config to include the apache pekko links.
  • Convert update akka-http-version.sh to update-pekko-http-version.sh

Not covered here:

  • UI bundle (continue using antora-supplemental for now)
  • Build tool : continue using antora for now, will consider conversion to use sbt-paradox to fit all other repos.

…ote custom antora image for pekko-guide builds
…(TBD) and UI bundle (continue using antora-supplemental for now)
…eploy-site script

The gustav VM was used for test purposes. In akka there was  long-lifetime akka.io website that main pipeline deploy-wip workflows would continuously deploy to. This will not be the case for pekko-platform guides so this is removed here.

I have kept the deploy-site script in case anyone wants to host their own local VM TEST_DEPLOYMENT_VM and deploy the site onto that.
The akka links are not removed yet since they still appear in docs and I don't want link-validator to fail
@sam-byng sam-byng changed the title WIP: PR update platform guide Issue 246: Initial PR: Convert Pekko Platform Guide project files Apr 28, 2023
@sam-byng sam-byng changed the title Issue 246: Initial PR: Convert Pekko Platform Guide project files Issue 244: Initial PR: Convert Pekko Platform Guide project files Apr 28, 2023
@sam-byng sam-byng marked this pull request as ready for review April 28, 2023 13:49
@sam-byng sam-byng marked this pull request as draft April 28, 2023 13:50
@sam-byng
Copy link
Author

TODO: Fixup CI pipelines - stop trying to publish to VM in CI AND fixup / remove telemetry sample stuff

… include Telemetry docs in this sample guide

Telemetry requires a lightbend license and account. I would say that we are ok to keep the docs in our website. However, we probably want to take out any tests that involve using Lightbend mvn credentials / a lightbend account to run telemetry code
@sam-byng
Copy link
Author

I've made the failing telemetry validation job workflow_dispatch only so that it will not cause main pipeline to fail.

I've raised an issue to discuss the retention of telemetry here: #22

@sam-byng sam-byng marked this pull request as ready for review April 28, 2023 14:30
@sam-byng
Copy link
Author

Telemetry guide will be removed in #23

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant