nchammas commented on code in PR #699: URL: https://github.com/apache/spark-website/pull/699#discussion_r4108061970
########## README.md: ########## @@ -1,10 +1,26 @@ -## Generating the website HTML +# Apache Spark Main Website -In this directory you will find text files formatted using Markdown, with an `.md` suffix. +This repository captures the main Apache Spark website located at https://spark.apache.org. The programming docs under https://spark.apache.org/docs/ are [in the main Spark repo][main], not here. They are built separately for each release of Spark and then copied to the website under the `docs/` directory. -Building the site requires [Ruby 3](https://www.ruby-lang.org), [Jekyll](http://jekyllrb.com/docs), and -[Rouge](https://github.com/rouge-ruby/rouge). The most reliable way to ensure a compatible environment -is to use the official Docker build image from the Apache Spark repository. +[main]: https://github.com/apache/spark/tree/master/docs#readme + +## Contributing + +To contribute changes, build and test the site locally, then submit a pull request with your changes. You only need to commit changes to the Markdown source. A [GitHub Actions workflow](.github/workflows/html-push.yml) will generate the corresponding HTML under `site/` and push it for you. Review Comment: These non-Markdown files are already addressed in the dedicated release guide. The typical PR does not need to worry about them. I'll tweak the wording here without repeating details that IMO are best left to the release guide. -- 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]
