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

Delete plutus-playground #821

Merged
merged 1 commit into from
Nov 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 0 additions & 62 deletions .github/workflows/plutus-playground-e2e-tests.yml

This file was deleted.

1 change: 0 additions & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ jobs:
- uses: nixbuild/nix-quick-install-action@v19
- run: |
nix --extra-experimental-features 'nix-command flakes' --extra-experimental-features flakes flake lock --option trusted-public-keys "hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ= iohk.cachix.org-1:DpRUyj7h7V830dp/i6Nti+NEO2/nhblbov/8MW7Rqoo= cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=" --option substituters "https://hydra.iohk.io https://iohk.cachix.org https://cache.nixos.org/"
nix-shell --extra-experimental-features 'nix-command flakes' --command "cd plutus-playground-client && (update-client-deps || update-client-deps)" --option trusted-public-keys "hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ= iohk.cachix.org-1:DpRUyj7h7V830dp/i6Nti+NEO2/nhblbov/8MW7Rqoo= cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=" --option substituters "https://hydra.iohk.io https://iohk.cachix.org https://cache.nixos.org/" # Double-call to work around bug in spago2nix on first fetch
# Disabled until we can find a way to run it only for Linux
# nix-shell --command "updateMaterialized" --option trusted-public-keys "hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ= iohk.cachix.org-1:DpRUyj7h7V830dp/i6Nti+NEO2/nhblbov/8MW7Rqoo= cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=" --option substituters "https://hydra.iohk.io https://iohk.cachix.org https://cache.nixos.org/"
git diff --exit-code
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,9 @@ pkgs/.stack
**/.spago/
**/.spago2nix/
**/.psa-stash
plutus-playground-client/generated
plutus-pab-executables/demo/pab-nami/client/generated

# Backend config files
marlowe-playground-server/playground.yaml
plutus-playground-server/playground.yaml
plutus-pab/plutus-pab.yaml

# Misc
Expand Down
14 changes: 0 additions & 14 deletions ARCHITECTURE.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,20 +37,6 @@ include::plutus-contract/ARCHITECTURE.adoc[]

include::plutus-use-cases/ARCHITECTURE.adoc[]

== Playground

The Plutus Playground is our web-based environment for developing and
testing basic Plutus contracts. That means it's the main way that
anyone outside the team has interacted with out product!

include::playground-common/ARCHITECTURE.adoc[]

include::plutus-playground-server/ARCHITECTURE.adoc[]

include::plutus-playground-client/ARCHITECTURE.adoc[]

include::web-common/ARCHITECTURE.adoc[]

== Smart Contract Backend

The smart contract backend provides the runtime environment for compiled Plutus contracts. It manages the state of contract instances and brokers messages between them and the nodes, users, and wallets that they interact with.
Expand Down
10 changes: 0 additions & 10 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ This repository contains:
* Plutus Platform
** Libraries which implement the Plutus Application Framework, a framework for writing applications that work with Cardano.
** A selection of end-to-end usecases written with the Plutus Application Framework
** The Plutus Playground, a web-based playground for learning and writing basic Plutus Applications.

[IMPORTANT]
====
Expand Down Expand Up @@ -167,15 +166,6 @@ Run `cabal build plutus-pab` from the root to build the Plutus PAB library.

See the link:./cabal.project[cabal project file] to see the other packages that you can build with `cabal`.

=== Deployment

The Plutus Playground is automatically deployed upon certain pushes to GitHub

* https://plutus-playground-plutus-apps-staging.plutus.aws.iohkdev.io/[Staging] is deployed from every commit pushed to `main` (this URL subject to change)
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we actually shutting down those servers? We have our haddock documentation in there.

Copy link
Author

Choose a reason for hiding this comment

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

From lines 35-40

=== User documentation

The main documentation is located https://plutus-apps.readthedocs.io/en/latest/[here].

The generated Haskell API documentation (haddocks) are here:
<https://playground.plutus.iohkdev.io/doc/haddock>.

These should be sufficient, no?
If so, should be actually ask for plutus-playground-plutus-apps-staging.plutus.aws.iohkdev.io to be shut down?

Copy link
Contributor

Choose a reason for hiding this comment

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

The https://playground.plutus.iohkdev.io/doc/haddock server hosts the haddock for a released version of plutus-apps. Whereas plutus-playground-plutus-apps-staging.plutus.aws.iohkdev.io hosts the haddock for the main branch. Both are useful. If you have a better way to restructure this, please suggest :)

Copy link
Author

Choose a reason for hiding this comment

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

There are other places in the README that say where to find the docs, so I think it's safe to delete those lines.
As for a possible restructure: if it works, and both are really useful, I wouldn't change it :)

* https://playground.plutus.iohkdev.io/[Production] is deployed from every release tag (matching `vYYYY-MM-DD`)

For more details, including instructions for setting up ad hoc testing deployments, see https://github.com/input-output-hk/plutus-ops[the plutus-ops repo].

[[nix-advice]]
== Nix

Expand Down
11 changes: 1 addition & 10 deletions bitte/default.nix
Original file line number Diff line number Diff line change
@@ -1,19 +1,10 @@
{ plutus-playground, web-ghc, docs, pkgs }:
{ docs, pkgs }:
let
staticSite = pkgs.callPackage ./static-site.nix { };
playgroundStatic = pkgs.callPackage ./playground-static.nix { inherit staticSite; docs = docs.site; };
in
{
web-ghc-server-entrypoint = pkgs.callPackage ./web-ghc-server.nix {
web-ghc-server = web-ghc;
};

plutus-playground-server-entrypoint = pkgs.callPackage ./plutus-playground-server.nix {
variant = "plutus";
pkg = plutus-playground.server;
};
plutus-playground-client-entrypoint = playgroundStatic {
client = plutus-playground.client;
variant = "plutus";
};
}
4 changes: 2 additions & 2 deletions bitte/playground-static.nix
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
let
shiftedDocs = linkFarm docs.name [{ name = "doc"; path = docs; }];
in
{ variant, client }: staticSite {
{ variant }: staticSite {
root = (symlinkJoin {
name = "${variant}-playground-client-and-docs";
paths = [ client shiftedDocs ];
paths = [ shiftedDocs ];
});
port-name = "${variant}_playground_client";
}
8 changes: 0 additions & 8 deletions bitte/plutus-playground-server.nix

This file was deleted.

7 changes: 0 additions & 7 deletions bitte/web-ghc-server.nix

This file was deleted.

2 changes: 0 additions & 2 deletions cabal.project
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,10 @@ packages: cardano-streaming
plutus-ledger-constraints
plutus-pab
plutus-pab-executables
plutus-playground-server
plutus-script-utils
plutus-tx-constraints
plutus-use-cases
rewindable-index
web-ghc

-- We never, ever, want this.
write-ghc-environment-files: never
Expand Down
2 changes: 1 addition & 1 deletion ci.nix
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ let
inherit forceNewEval;
} // pkgs.lib.optionalAttrs (!rootsOnly) (filterCross {
# build relevant top level attributes from default.nix
inherit (packages) docs tests plutus-playground plutus-use-cases;
inherit (packages) docs tests plutus-use-cases;

# Build the shell expression to be sure it works on all platforms
#
Expand Down
15 changes: 1 addition & 14 deletions default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -28,24 +28,12 @@ in
rec {
inherit pkgs plutus-apps;

inherit (plutus-apps) web-ghc;

inherit (haskell.packages.plutus-pab-executables.components.exes)
plutus-pab-examples
plutus-uniswap;

webCommon = pkgs.callPackage sources.web-common { inherit (plutus-apps.lib) gitignore-nix; };

plutus-playground = pkgs.recurseIntoAttrs rec {
haddock = plutus-apps.plutus-haddock-combined;

inherit (pkgs.callPackage ./plutus-playground-client {
inherit (plutus-apps) purs-tidy;
inherit (plutus-apps.lib) buildPursPackage buildNodeModules filterNpm gitignore-nix;
inherit haskell webCommon;
}) client server start-backend generate-purescript;
};

# TODO: Fails for now because of webpack can't include `nami-wallet` lib in it's bundle.
# To reproduce the error, run `npm run build:webpack:prod` in `plutus-pab-executables/demo/pab-nami/client`
pab-nami-demo = pkgs.recurseIntoAttrs rec {
Expand Down Expand Up @@ -74,7 +62,6 @@ rec {
inherit pkgs docs;
inherit (plutus-apps.lib) gitignore-nix;
inherit (plutus-apps) fixStylishHaskell fix-purs-tidy fixPngOptimization fixCabalFmt;
inherit plutus-playground web-ghc;
src = ./.;
};

Expand All @@ -86,5 +73,5 @@ rec {
build-and-push-devcontainer-script = import ./nix/devcontainer/deploy/default.nix { inherit pkgs plutus-apps; };

# Packages needed for the bitte deployment
bitte-packages = import ./bitte { inherit plutus-playground docs pkgs web-ghc; };
bitte-packages = import ./bitte { inherit docs pkgs; };
}
2 changes: 1 addition & 1 deletion deployment.nix
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
, packages ? import ./. { inherit system enableHaskellProfiling; }
}:
let
inherit (packages) pkgs plutus-apps plutus-playground pab-nami-demo plutus-chain-index pab-cli docs webCommon;
inherit (packages) pkgs plutus-apps pab-nami-demo plutus-chain-index pab-cli docs webCommon;
inherit (pkgs) lib utillinux python3 nixpkgs-fmt;
inherit (plutus-apps) haskell;

Expand Down
9 changes: 0 additions & 9 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,6 @@
sys.path.insert(0, abspath(join(dirname(__file__))))
sys.path.append(os.path.abspath('exts'))

# -- Doc config values
marlowe_playground_url = "https://alpha.marlowe.iohkdev.io/"
plutus_playground_url = "https://alpha.plutus.iohkdev.io/"

rst_epilog = """
.. _Plutus Playground: {0}
.. _Marlowe Playground: {1}
""".format(plutus_playground_url, marlowe_playground_url)

# -- RTD configuration ------------------------------------------------

on_rtd = os.environ.get("READTHEDOCS", None) == "True"
Expand Down
1 change: 0 additions & 1 deletion doc/plutus/tutorials/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Tutorials
:maxdepth: 2
:titlesonly:

plutus-playground
basic-apps
basic-apps-constraints
contract-testing
Expand Down
Loading