You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pouchdb.apache.org by ja...@apache.org on 2026/06/03 14:17:12 UTC

(pouchdb) 08/12: docs: add info on new releases and website deployment to the website readme

This is an automated email from the ASF dual-hosted git repository.

janl pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pouchdb.git

commit 83bbe387d8499a355a91852c7a3eb9234d00a489
Author: Alex Feyerke <al...@neighbourhood.ie>
AuthorDate: Tue Jun 2 11:43:25 2026 +0200

    docs: add info on new releases and website deployment to the website readme
---
 docs/WEBSITE_README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/docs/WEBSITE_README.md b/docs/WEBSITE_README.md
index e0ad6b8be..031ef3ebd 100644
--- a/docs/WEBSITE_README.md
+++ b/docs/WEBSITE_README.md
@@ -34,6 +34,19 @@ By default, SW will only cache the pages you’ve seen plus `offline.html`, whic
 
 To test the "Content updated, reload now?" toast that indicates that a new version of the site is available, run the dev server, make a change to the site (e.g. change some text somewhere), then navigate once or reload the page with a normal (not hard) reload. The update toast should show. When you click it, the page and the serviceworker cache will be updated.
 
+## PouchDB Version Updates
+
+If you’re releasing a new PouchDB version, the site also needs some updates:
+
+1. Replace `docs/static/js/pouchdb.min.js` with your newly built version of the same file (this is the PouchDB that is hosted by the website itself and available in the browser dev console).
+2. Update the `version` key in `docs/_data/site.js` to the new PouchDB version.
+
+Then deploy the webite.
+
+## Website Deployment
+
+Currently, the website is deployed manually by members of the team. In the near future, any website changes merged into `master` will be deployed automatically.
+
 ## Technology Choices
 
 The PouchDB website is over a decade old and some parts of it are somewhat out of date by now, but they haven’t been updated for good reasons. The most significant legacy bit is Bootstrap 3.11 in the LESS version, which depends on JQuery for interactivity. There is currently zero benefit to, for example, migrating to SASS/SCSS here or trying to untangle JQuery from Bootstrap in order to use vanilla JS. A design update is on the horizon, and we’ll take that as an opportunity to remove Boo [...]