beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From al...@apache.org
Subject [beam] branch master updated: updated site docs with troubleshooting info
Date Wed, 21 Jul 2021 19:16:10 GMT
This is an automated email from the ASF dual-hosted git repository.

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


The following commit(s) were added to refs/heads/master by this push:
     new 7b1f7ea  updated site docs with troubleshooting info
     new 61a884e  Merge pull request #15182 from pcoet/website-docs
7b1f7ea is described below

commit 7b1f7eaae7c2d57ea3a316ab500559ca3afa806e
Author: David Huntsperger <dhuntsperger@google.com>
AuthorDate: Fri Jul 16 16:22:23 2021 +0000

    updated site docs with troubleshooting info
---
 website/README.md | 32 ++++++++++++++++++++++++++++----
 1 file changed, 28 insertions(+), 4 deletions(-)

diff --git a/website/README.md b/website/README.md
index 8a2d7a6..d5f9a6f 100644
--- a/website/README.md
+++ b/website/README.md
@@ -24,9 +24,7 @@ https://beam.apache.org/.
 
 ## About
 
-The Beam website is built using [Hugo](https://gohugo.io/). Additionally,
-for additional formatting capabilities, this website uses
-[Twitter Bootstrap](https://getbootstrap.com/).
+The Beam website is built using [Hugo](https://gohugo.io/) and the Hugo theme [Docsy](https://www.docsy.dev/).
For additional formatting capabilities, this website uses [Twitter Bootstrap](https://getbootstrap.com/).
 
 Documentation generated from source code, such as Javadoc and Pydoc, is stored
 separately on the [beam-site
@@ -63,4 +61,30 @@ https://beam.apache.org/.
 
 ## Contribution guide
 
-If you'd like to contribute to the Apache Beam website, read our [contribution guide](CONTRIBUTE.md)
where you can find detailed instructions on how to work with the website.
\ No newline at end of file
+If you'd like to contribute to the Apache Beam website, read our [contribution guide](CONTRIBUTE.md)
where you can find detailed instructions on how to work with the website.
+
+## Additional resources
+
+If you're developing the site, you should know a little bit about Hugo and Docsy. The following
external resources will help you get up and running:
+
+- [Directory Structure](https://gohugo.io/getting-started/directory-structure/)
+- [Adding Content](https://www.docsy.dev/docs/adding-content/content/)
+- [Shortcodes](https://gohugo.io/content-management/shortcodes/)
+- [Introduction to Hugo Templating](https://gohugo.io/templates/introduction/)
+- [Partial Templates](https://gohugo.io/templates/partials/)
+
+## Troubleshooting
+
+### Hugo server does not reload static files
+
+The Hugo dev server waits for changes in site content, static files, configuration, and other
resources. On change, the server rebuilds and reloads the site in your browser. If you're
making changes to static files, and those changes are detected by the server but don't appear
in the browser, you may have a caching issue.
+
+You can tell that the server has detected a change by looking at the output. For example,
if you make a change to **website/www/site/static/js/section-nav.js**, you should see something
like:
+
+```
+Change of Static files detected, rebuilding site.
+2021-07-16 15:25:29.730 +0000
+Syncing js/section-nav.js to /
+```
+
+If the change does not appear in the browser, even after a hard refresh, try disabling the
cache. For example, to disable the cache in Chrome, open dev tools, select the Network tab,
and check the box labeled "Disable cache".

Mime
View raw message