diff --git a/MAINTAINING.md b/MAINTAINING.md index e9b29357a..0b8769e77 100644 --- a/MAINTAINING.md +++ b/MAINTAINING.md @@ -14,7 +14,7 @@ The main parts that constitute this system are: - two websites - main: https://examples.holoviz.org - dev: https://holoviz-dev.github.io/examples/ -- an Anaconda Enterprise instance hosted at https://pyviz.demo.anaconda.com/ +- an Anaconda Enterprise instance hosted at https://holoviz-dev.anaconda.com/ Each project, also called example, is an [anaconda-project](https://anaconda-project.readthedocs.io/), capturing the dependencies, data and commands required to execute the project. @@ -38,20 +38,39 @@ The system has been designed to cope with multiple projects being touched at onc It is also possible to remove projects via a Pull Request, the system should remove the data in the `evaluated` branch and remove the projects on Anaconda Enterprise. -## Commands +## Set up admin/contributor environment -The `doit` task runner is used to implement many tasks required to maintain the system. -These tasks are implemented in Python and can be found in the `dodo.py` file. +Install conda and run this to install the dependencies required to manage the system +(pick the file in the `envs/` folder that matches with your platform): -Run this to install the dependencies required to manage the system: +```bash +conda create -n examples-gallery-manage --file envs/environment-osx-arm64.lock +conda activate examples-gallery-manage +``` + +Alternatively, you could install the latest dependencies with this command: ```bash conda env create --file envs/environment.yml -conda activate examples-gallery-manage ``` +## Update admin/contributor environment + +1. Update manually `envs/environment.yml`, if needed +2. Install `conda-lock` in your environment (dedicated one preferably, or `base`) +3. Run `cd envs` and `bash lock.yml` + +## Commands + +The `doit` task runner is used to implement many tasks required to maintain the system. +These tasks are implemented in Python and can be found in the `dodo.py` file. + Run `doit list` to list all the commands available. +### Build the website + +To build the full website, run `doit doc_full`. This might take a little while as this involve multiple steps, such as building the archived projects, or checking out locally the `evaluated` branch to retrieve the evaluated notebooks. Once executed, running `doit doc_build_website` is enough to re-build the site only. + ## GitHub Actions Scheduled runs: @@ -82,8 +101,8 @@ to the zip file. Once your project has been created, you can deploy it. The endpoints should be: -- notebook: `-notebook.pyviz.demo.anaconda.com` -- dashboard: `.pyviz.demo.anaconda.com` +- notebook: `-notebook.holoviz-demo.anaconda.com` +- dashboard: `.holoviz-demo.anaconda.com` where `` is the project name, with underscores turned into hyphens. diff --git a/dodo.py b/dodo.py index 724f38047..61ec39f78 100644 --- a/dodo.py +++ b/dodo.py @@ -604,7 +604,7 @@ def list_ae5_deployments(session, name=None): deployments = session.deployment_list(format="json") - # {'url': 'https://gapminders.pyviz.demo.anaconda.com/', + # {'url': 'https://gapminders.holoviz-demo.anaconda.com/', # 'public': True, # 'created': '2022-12-08T11:12:20.538714+00:00', # 'project_name': 'gapminders', @@ -662,7 +662,7 @@ def list_ae5_sessions(session, name): # '_record_type': 'session', # 'created': '2022-12-14T15:38:25.795710+00:00', # 'id': 'a1-8bfc935b04794519bc3d2b637d3b51a7', - # 'iframe_hosts': 'https://pyviz.demo.anaconda.com', + # 'iframe_hosts': 'https://holoviz-demo.anaconda.com', # 'name': 'Panel-Gallery', # 'owner': 'anaconda-enterprise', # 'project_branch': 'anaconda-enterprise-d979c8be607b4745ac817dc6477f770d', diff --git a/template/anaconda-project.yml b/template/anaconda-project.yml index fee6ca8d7..d0eecfd16 100644 --- a/template/anaconda-project.yml +++ b/template/anaconda-project.yml @@ -34,9 +34,9 @@ examples_config: # Each deployment must declare the command it deploys, options # include "notebook" or "dashboard". deployments: - # Will be deployed at {projname_with_hyphens}-notebook.pyviz.demo.anaconda.com + # Will be deployed at {projname_with_hyphens}-notebook.holoviz-demo.anaconda.com - command: notebook - # Will be deployed at {projname_with_hyphens}.pyviz.demo.anaconda.com + # Will be deployed at {projname_with_hyphens}.holoviz-demo.anaconda.com - command: dashboard # [OPTIONAL] Set the AE5 container resource profile. # Options include: "default" (default), "medium", "large"