[
https://issues.apache.org/jira/browse/BEAM-4501?focusedWorklogId=150420&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-150420
]
ASF GitHub Bot logged work on BEAM-4501:
----------------------------------------
Author: ASF GitHub Bot
Created on: 02/Oct/18 15:58
Start Date: 02/Oct/18 15:58
Worklog Time Spent: 10m
Work Description: swegner commented on a change in pull request #6533:
[BEAM-4501] Update website contribution and release docs
URL: https://github.com/apache/beam/pull/6533#discussion_r222002789
##########
File path: website/README.md
##########
@@ -18,14 +18,26 @@ The Beam website is built using
[Jekyll](http://jekyllrb.com/). Additionally,
for additional formatting capabilities, this website uses
[Twitter Bootstrap](http://getbootstrap.com/).
-### Repository Structure
+Documentation generated from source code, such as Javadoc and Pydoc, is stored
+separately on the [beam-site
+repository](https://github.com/apache/beam-site/tree/asf-site/content/documentation/sdks).
-This repository contains:
+## Development Workflow with Docker
-1. `src/`: the source of the site, including markdown files containing the
bulk of the content
-1. `content/`: html generated from the markdown (which is what is actually
hosted on the website)
+### Active development
+
+If you have Docker configured on your machine, the following command may be
used
+to build and serve the website locally.
+
+ $ ./gradlew :beam-website:serveWebsite
+
+Any changes made locally will trigger a rebuild of the website.
-## Development Workflow
+You can also run website tests using this command:
+
+ $ ./gradlew :beam-website:testWebsite
+
+## Development Workflow without Docker
### Setup
Review comment:
Are these setup steps still necessary? I believe the website build all
happens within a Docker container now.
Also, do you think we should continue to document the raw bundle / jekyll
commands, or recommend that users only build/test via the gradle wrapper? My
preference would be to only use gradle so we can change what's underneath more
easily.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 150420)
Time Spent: 0.5h (was: 20m)
> Update contribution guide for new website contribution process
> --------------------------------------------------------------
>
> Key: BEAM-4501
> URL: https://issues.apache.org/jira/browse/BEAM-4501
> Project: Beam
> Issue Type: Sub-task
> Components: website
> Reporter: Scott Wegner
> Assignee: Udi Meiri
> Priority: Major
> Labels: beam-site-automation-reliability
> Time Spent: 0.5h
> Remaining Estimate: 0h
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
