celestehorgan commented on code in PR #699:
URL: https://github.com/apache/spark-website/pull/699#discussion_r3727311649
##########
.github/actions/build-html/action.yml:
##########
@@ -0,0 +1,22 @@
+name: Build HTML
+
+description: Set up Ruby and run the Jekyll build.
+
+inputs:
+ ruby-version:
+ description: Ruby version to use.
+ required: false
+ default: "3.4"
+
+runs:
+ using: composite
+ steps:
+ - name: Set up Ruby and Bundler
+ uses: ruby/setup-ruby@v1
+ with:
+ ruby-version: ${{ inputs.ruby-version }}
Review Comment:
Non-blocking question: is there a chance that people (accidentally) commit
the Gemfile.lock and (accidentally) bump the ruby version?
##########
README.md:
##########
@@ -21,29 +45,16 @@ the Markdown files in the Docker container.
.dev/build-docs.sh
```
-## Docs sub-dir
-
-The docs are not generated as part of the website. They are built separately
for each release
-of Spark from the Spark source repository and then copied to the website under
the docs
-directory. See the instructions for building those in the readme in the Spark
-project's `/docs` directory.
-
-## Rouge and Pygments
-
-We also use [Rouge](https://github.com/rouge-ruby/rouge) for syntax
highlighting in documentation Markdown pages.
-Its HTML output is compatible with CSS files designed for
[Pygments](https://pygments.org/).
+## Deploying to production
-To mark a block of code in your Markdown to be syntax highlighted by `jekyll`
during the
-compile phase, use the following syntax:
+The website is deployed automatically by [ASF Infra][infra]. The deployment
configuration is tracked by [.asf.yaml](./.asf.yaml) and is [documented
here][asf-docs].
- {% highlight scala %}
- // Your Scala code goes here, you can replace Scala with many other
- // supported languages too.
- {% endhighlight %}
+One deployment detail that appears to be critical is the presence of the
[`content`](./content/) symlink to `site/`. Even though ASF Infra is [aware of
Jekyll][jek], we perhaps do not have the exact setup required for them to
automatically use our [Jekyll config](./_config.yml) to understand where the
site content lives. Without the `content` symlink, the website will just show a
plain directory listing of the files in this repo.
Review Comment:
Non-blocking:
I saw that in commit fd110d9c7b9148750889148f29243d52e7b5cd03 you removed
the `content` symlink and then readded it in
d7a321672e79d854659934b6caa3784d199f61ee .. what exactly happened here?
I think it's actually worth _removing_ this note. What folks don't know
can't hurt em' 😅 and I think you might actually confuse/send people down the
wrong path otherwise.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
