[
https://issues.apache.org/jira/browse/AVRO-2175?focusedWorklogId=732184&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-732184
]
ASF GitHub Bot logged work on AVRO-2175:
----------------------------------------
Author: ASF GitHub Bot
Created on: 24/Feb/22 09:19
Start Date: 24/Feb/22 09:19
Worklog Time Spent: 10m
Work Description: martin-g commented on a change in pull request #1559:
URL: https://github.com/apache/avro/pull/1559#discussion_r813613994
##########
File path: doc/README.md
##########
@@ -0,0 +1,146 @@
+# Apache Avro website
+
+This is a repository of Apache Avro website. The repository of Apache Avro can
be found [here](https://github.com/apache/avro).
+
+This website is base on [Hugo](https://gohugo.io) and uses
[Docsy](https://www.docsy.dev/) theme.
+
+## Getting started
+
+Clone this repository:
+
+```bash
+git clone --recurse-submodules https://github.com/apache/avro-website.git
+```
+
+You can now edit your own versions of the site’s source files.
+
+If you want to do SCSS edits and want to publish these, you need to install
`PostCSS`
+
+```bash
+npm install
+```
+
+## Work flow
+
+1. Building and running the site locally requires a recent `extended` version
of [Hugo](https://gohugo.io).
+You can find out more about how to install Hugo for your environment in our
+[Getting
started](https://www.docsy.dev/docs/getting-started/#prerequisites-and-installation)
guide.
+Once you've made your working copy of the site repo, from the repo root
folder, run:
+
+
+ ```
+ hugo server --navigateToChanged
+ ```
+
+1. Edit .md and .html files in `content/` folder
+1. Once satisfied with the changes, commit them:
+
+ ```
+ git commit -a
+ ```
+
+1. Generate the HTML filse
+stop `hugo server --navigateToChanged` (with Ctrl+C) and run
+
+ ```
+ hugo --gc --minify
+ ```
+
+ This will generate the HTMLs in `public/` folder and this is actually what
is being deployed
+
+1. Add the modified HTML files to Git
+
+ ```
+ git add .
+ git rm offline-search-index.<<OLD-HASH>>.json
+ git commit -a
+ git push
Review comment:
These steps should also be removed.
AFAIU the `content/` folder should be copied to nightlies or SVN publish
folder.
**Edit**: s/content/public/
--
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]
Issue Time Tracking
-------------------
Worklog Id: (was: 732184)
Time Spent: 1h 10m (was: 1h)
> website refactor
> ----------------
>
> Key: AVRO-2175
> URL: https://issues.apache.org/jira/browse/AVRO-2175
> Project: Apache Avro
> Issue Type: Task
> Components: community
> Reporter: Sean Busbey
> Assignee: Martin Tzvetanov Grigorov
> Priority: Critical
> Labels: pull-request-available
> Fix For: 1.11.1
>
> Time Spent: 1h 10m
> Remaining Estimate: 0h
>
> https://lists.apache.org/thread.html/4b804f4e99dc9975c42af59485225808846648b90015f04ab9787246@%3Cdev.avro.apache.org%3E
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
