Fixes #82 Moved docs source from Fluo repo to website #83
Conversation
| * T1 commits successfully and its commit timestamp from the Oracle is `4`. | ||
| * Transaction T2 has a start timestamp of `5` (because its `5` > `4` it can see what T1 wrote). | ||
| * T2 reads a value of `1` for row `4333` and column `stat count` | ||
| * T2 sets row `4333` and `column `stat count` to `2` |
There was a problem hiding this comment.
This is bug that was copied over. I noticed it while looking at this rendered through jekyll. There is an extraneous back tick in front of column.
_layouts/fluo-docs-1.2.html
Outdated
| skiph1fortitle: true | ||
| --- | ||
|
|
||
| <div class="row"> |
There was a problem hiding this comment.
This sidebar is really slick.
_fluo-docs-1-2/index.md
Outdated
| nodoctitle: true | ||
| --- | ||
|
|
||
| # Apache Fluo {{ page.version }} documentation |
There was a problem hiding this comment.
The following concept is not fully formed, just sharing for consideration and discussion.
Maybe we could remove this page and do the following.
- Add Release notes and Javadocs to sidebar.
- When linking to 1.2/ docs, maybe it just redirects to 1.2/design. So when you go to the 1.2 docs it goes to the design docs and that shows as open in the sidebar.
- The Fluo Tour link is that the top of every Fluo page.. so maybe a Tour link is not needed.
_config.yml
Outdated
| @@ -34,6 +40,19 @@ defaults: | |||
| values: | |||
| layout: "tour" | |||
| permalink: "/tour/:basename/" | |||
| - | |||
| scope: | |||
| path: "" | |||
There was a problem hiding this comment.
Can you explain these changes? I am not sure how they are used. Why is path empty? What is skiph1fortitle? I suspect this section is somehow for 1.2 doc specific vars, but not sure.
There was a problem hiding this comment.
Path shouldn't be empty. Also skiph1fortitle can be removed. This should be fixed now.
| minor_release: "1.2" | ||
| docs_base: "/docs/fluo/1.2" | ||
| javadoc_base: "https://static.javadoc.io/org.apache.fluo/fluo-api/1.1.0-incubating" | ||
| github_base: "https://github.com/apache/fluo/blob/master" |
There was a problem hiding this comment.
Should this be a tag? The 1.2 tag eventually? If so, maybe we can open an issue or set it now?
| [InfluxDB]: https://influxdb.com/ | ||
| [fluo-app.properties]: {{ site.github_base }}/modules/distribution/src/main/config/fluo-app.properties | ||
| [Dropwizard]: https://dropwizard.github.io/metrics/3.1.0/ | ||
| [grafana]: {{ site.docs_base}}/administration/grafana/ |
There was a problem hiding this comment.
Yes. It's removed now.
| [fluo-app.properties]: {{ site.github_base }}/modules/distribution/src/main/config/fluo-app.properties | ||
| [Dropwizard]: https://dropwizard.github.io/metrics/3.1.0/ | ||
| [grafana]: {{ site.docs_base}}/administration/grafana/ | ||
| [MetricsReporter]: {{ site.github_base }}/modules/api/src/main/java/org/apache/fluo/api/metrics/MetricsReporter.java |
There was a problem hiding this comment.
Seems like these should point to javadocs.
| where D is a hex digit. Also the `\` character is escaped to make the output unambiguous. | ||
|
|
||
| [design]: {{ page.docs_base }}/getting-started/design/ | ||
| [FluoFactory]: {{ page.github_base}}/modules/api/src/main/java/org/apache/fluo/api/client/FluoFactory.java |
There was a problem hiding this comment.
Seems like this should point to javadoc.
There was a problem hiding this comment.
I fixed all javadoc references in d857181
| order: 1 | ||
| --- | ||
|
|
||
| For a general overview of Fluo, take the [Fluo tour](/tour/). The diagram below provides an |
There was a problem hiding this comment.
Not sure this link to Fluo tour is needed, but it doesn't hurt.
Collections need to exists in directory at root that starts with underscore. |
No description provided.