You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ep...@apache.org on 2021/03/09 13:40:40 UTC
[lucene-site] 01/01: Merge pull request #42 from
apache/fix_command_example
This is an automated email from the ASF dual-hosted git repository.
epugh pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucene-site.git
commit 97c1c2c2550060af53acb898f9f10b986d1cfcb7
Merge: 64cd545 813e187
Author: Eric Pugh <ep...@opensourceconnections.com>
AuthorDate: Tue Mar 9 08:40:30 2021 -0500
Merge pull request #42 from apache/fix_command_example
fix the example command
README.md | 4 ++--
build.sh | 6 +++---
2 files changed, 5 insertions(+), 5 deletions(-)
diff --cc README.md
index 701e7fe,021ecab..4891090
--- a/README.md
+++ b/README.md
@@@ -7,19 -5,17 +7,19 @@@ This repository contains the "source co
## Building the site
The site is written in [Markdown][9] syntax and built into a static site using [Pelican][1]. The site is re-built automatically by [ASF Buildbot][5] on every push to master branch and the result can be previewed at [lucene.staged.apache.org][6]. Build success/failure emails are sent to [commits@lucene.apache.org][7] mailing list. Read more about the mechanics behind auto building in [INFRA Confluence][8].
-
+
If the staged site looks good, simply merge the changes to branch `production` and the site will be deployed in a minute or two. Note that simple edits can also be done directly in the GitHub UI rather than clone -> edit -> commit -> push.
+> **IMPORTANT**: Please never commit directly to `production` branch. All commits should go to master, and then merge master to production. Note that it **is** possible to make a Pull Request for the merge from `master-->production`. If you do so, please merge using a merge commit rather than a squash merge.
+
For larger edits it is recommended to build and preview the site locally. This lets you see the result of your changes instantly without committing anything. The next sections detail that procedure. The TL;DR instructions goes like this:
# Usage: ./build.sh [-l] [<other pelican arguments>]
# -l Live build and reload source changes on localhost:8000
# --help Show full help for options that Pelican accepts
- ./build -l
+ ./build.sh -l
-Now go to <http://localhost:8000> to view the beautiful Lucene/Solr web page served from your laptop with live-preview of updates :)
+Now go to <http://localhost:8000> to view the beautiful Lucene web page served from your laptop with live-preview of updates :)
### Installing Pelican by hand