Fluo 1.0.0 #23
Fluo 1.0.0 #23
Conversation
|
Diff is far too big to preview/review in GitHub. Can you strip out the commit which adds the javadocs, and just put in a placeholder to be fixed before merging? Also, this raises the question... do we really need apidocs published on our site, when they are already published to Maven Central, and hosted at various sites, such as https://javadoc.io/doc/org.apache.fluo/fluo-api/1.0.0-incubating ? |
| @@ -31,8 +31,10 @@ | |||
| </div> | |||
| <div class="collapse navbar-collapse js-navbar-collapse" style="margin-top: 20px"> | |||
| <ul class="navbar-nav nav"> | |||
| <li><a href="{{ site.baseurl }}/docs/">Documentation</a></li> | |||
| <li><a href="{{ site.baseurl }}/download/">Download</a></li> | |||
| <li><a href="{{ site.baseurl }}/release/">Releases</a></li> | |||
There was a problem hiding this comment.
This is feedback based on my first impression. At first I was not sure where to download from the main page. I was thinking this could be called downloads instead of releases. My thinking is that users would look for download more frequently than release notes. I'm ok with leaving it as releases, I'm used to it now.
There was a problem hiding this comment.
The /release/ page contains a list of releases. If you click on a release, you get more information on that release. Changing the name to 'Downloads' is a little confusing as each link doesn't download the tarball. What if I created an issue to add a link to 'download latest fluo release' somewhere on the main page that links to latest release page?
There was a problem hiding this comment.
I don't think a link directly to the latest download would be appropriate unless it is accompanied by instructions on verifying the release and downloading hashes/sigs. We can do this on the releases posts, but an independent link directly to the download is more problematic. Maybe a link directly to the "Latest Release" instead?
There was a problem hiding this comment.
I agree. I'll make sure the issue says 'latest release'
| Apache Fluo is happy to announce a [1.0.0-incubating][rel] release. This is the first | ||
| release of Fluo as an Apache project and the fourth release for the project. Starting | ||
| with this release, Fluo will follow [semver][semver] for all future API changes. See | ||
| the [release page][rel] for more information. |
There was a problem hiding this comment.
This last sentence seems redundant. since link is also in 1st sentence.
| --- | ||
|
|
||
| Apache Fluo 1.0.0-incubating is the first release of Fluo as an Apache project and the fourth | ||
| release for the project. Since the beta-2 release there were [167 commits][commits] by | ||
| [cjmctague], [ctubbsii], [Garvit244], [keith-turner], [mikewalch]. Information about all |
There was a problem hiding this comment.
can remove these people links at the end of the doc
| made to the oracle followed by a request for 3 timestamps, then the count for `oracle_server_stamps` | ||
| would be 2 and the mean would be (5+3)/2. | ||
|
|
||
| [fluo.properties]: https://github.com/apache/fluo/blob/1.0.0-incubating/modules/distribution/src/main/config/fluo.properties |
There was a problem hiding this comment.
This link does not work. I got the following link to work.
| [related]: https://fluo.apache.org/related-projects/ | ||
| [release]: https://fluo.apache.org/download/ | ||
| [phrasecount]: https://github.com/fluo-io/phrasecount | ||
| [fluo.properties]: https://github.com/apache/fluo/blob/1.0.0-incubating/modules/distribution/src/main/config/fluo.properties |
There was a problem hiding this comment.
This link and the following two links do not work
Personally, I like having the javadocs on the Fluo website. However I am not opposed to dropping it from our website. I like that it will be less work for us. Also, javadoc.io does not currently have any advertisements. I looked at the source for javadoc.io, they seem to track using google analytics which is ok w/ me. We could put a base javadoc url in _config.yml. Then we can update all javadoc links to use this base. This will allow use to easily switch in the future if the website goes away or starts being sleazy in some way. |
mikewalch
force-pushed
the
fluo-1.0.0
branch
2 times, most recently
from
9369a81
to
a64f581
Compare
* Set correct date for 1.0.0-incubating release * Release summary pages are now called releases * Added 'Releases', 'Tour', 'Docs', & 'API' links to main page * Removed download link on main page as each release has link * Release notes and release 'posts' can now be either Fluo or Fluo Recipes * API and docs pages each have index and archive to pre-ASF * Added documentation and blog post for 1.0.0-incubating release * Updated github-pages to version 97 * Updated links to external javadocs
No description provided.