[
https://issues.apache.org/jira/browse/AVRO-2175?focusedWorklogId=731895&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-731895
]
ASF GitHub Bot logged work on AVRO-2175:
----------------------------------------
Author: ASF GitHub Bot
Created on: 23/Feb/22 20:07
Start Date: 23/Feb/22 20:07
Worklog Time Spent: 10m
Work Description: RyanSkraba opened a new pull request #1559:
URL: https://github.com/apache/avro/pull/1559
I've spent many hours trying to iron out the process for publishing the
refactored website on #1528 -- I've got a good handle on it, and a good list of
things that need to be done from the experience!
Unfortunately, it's just dragging on and on and making it difficult for
other contributors (or to propose a release 1.11.1...)
I think it would help to merge it to master with the existing content and
then proceed with fixes until we get it into a releasable state! To that goal,
I want to propose this alternative PR, which contains _largely_ the same
content but:
* Keeps the old `doc` folder around, renamed as `doc-deprecated` (for
temporary reference),
* Imports the https://github.com/google/docsy-example template in a separate
commit, refering to the exact commit source. I think it will be useful in
maintenance to be able to distinguish between our content and the original
template content.
* I tried to keep the exact content proposed by @martin-g, but I used `git
submodule` instead of copying the repos over.
* I also stripped all of the generated javadoc and doxygen -- as a
consequence, these will have to be imported during a build step.
* I added licenses to all of the content files.
I think I have a much better handle in how we need to proceed -- and I've
got a lot of README documentation so we can get this in place for the next
release!
### Jira
- [X] My PR addresses the AVRO-2175 (Based on the work of @martin-g and
@opwvhk)
### Tests
- [X] My PR does not need testing for this extremely good reason: will be
checked manually during a release.
### Commits
- [X] My commits all reference Jira issues in their subject lines. In
addition, my commits follow the guidelines from "[How to write a good git
commit message](https://chris.beams.io/posts/git-commit/)":
1. Subject is separated from body by a blank line
1. Subject is limited to 50 characters (not including Jira issue reference)
1. Subject does not end with a period
1. Subject uses the imperative mood ("add", not "adding")
1. Body wraps at 72 characters
1. Body explains "what" and "why", not "how"
### Documentation
- [ ] In case of new functionality, my PR adds documentation that describes
how to use it.
- All the public functions and the classes in the PR contain Javadoc that
explain what it does
--
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: 731895)
Remaining Estimate: 0h
Time Spent: 10m
> 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
> Fix For: 1.11.1
>
> Time Spent: 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)
