Issue 5889: Convert markdown to support Docusaurus and combined docs repo #6424
Conversation
derekm
changed the title
Make documentation compatible with Docusaurus Signed-off-by: wenqi mou <Wenqi.Mou@dell.com>
Signed-off-by: Derek Moore <derek.moore@dell.com>
Codecov Report
@@ Coverage Diff @@
## master #6424 +/- ##
==========================================
Coverage 86.26% 86.26%
+ Complexity 15434 15419 -15
==========================================
Files 1008 1005 -3
Lines 57760 57631 -129
Branches 5885 5877 -8
==========================================
- Hits 49828 49718 -110
+ Misses 4870 4859 -11
+ Partials 3062 3054 -8
Continue to review full report at Codecov.
|
Signed-off-by: Derek Moore <derek.moore@dell.com>
| @@ -17,6 +17,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |||
| See the License for the specific language governing permissions and | |||
| limitations under the License. | |||
| --> | |||
| import versions from '@site/versions'; | |||
There was a problem hiding this comment.
@RaulGracia & @SrishT -- I've updated the "Deploy on K8s" docs to include the latest instructions as well as the latest versions. Versions are substituted in from here: pravega/docs@cf71c4b#diff-21a0578522c567f65881e4e8dc3aaace32d60dbdabf2730082b7d9da9f6cb4d0
|
|
||
| Method | Write | Transactional Write | Read | Special Features | Notes | ||
| ------------------------------------------------------------------------------------------------|-------|---------------------|------|------------------|------------------------------------------------------ | ||
| [Pravega Sensor Collector](#pravega-sensor-collector) | Yes | Yes | No | EO | |
There was a problem hiding this comment.
There are links not working in this table. We also may need to consider a couple of things bout this table: i) should we order the list in terms of popularity and/or client completeness? For those really experimental connectors or under development, should we note that in the last column?
There was a problem hiding this comment.
Fixed table links and entry descriptions. Still open questions about columns/completeness.
| Pravega Sensor Collector can continuously collect high-resolution samples without interruption, even if the network connection to the Pravega server is unavailable for long periods. For instance, in a connected train use case, there may be long periods of time between cities where there is no network access. During this time, Pravega Sensor Collector will store collected sensor data on a local disk and periodically attempt to reconnect to the Pravega server. It stores this sensor data in local SQLite database files. When transferring samples from a SQLite database file to Pravega, it coordinates a SQLite transaction and a Pravega transaction. This technique allows it to guarantee that all samples are sent in order, without gaps, and without duplicates, even in the presence of computer, network, and power failures. | ||
|
|
||
| <IfHaveFeature feature="nautilus"> | ||
| ## SDP Ingest Gateway |
There was a problem hiding this comment.
Do we need this given that we are just linking the connectors to their repos?
There was a problem hiding this comment.
You mean why does Pravega Sensor Collector get a description and not other connectors? @claudiofahey provided this page, but perhaps we can clean it up further.
documentation/src/docs/javadoc.md
Outdated
| @@ -1,3 +1,7 @@ | |||
| --- | |||
| title: Pravega API Reference | |||
There was a problem hiding this comment.
Last Javadoc link does not work.
Signed-off-by: Derek Moore <derek.moore@dell.com>
Signed-off-by: Derek Moore <derek.moore@dell.com>
Signed-off-by: Derek Moore <derek.moore@dell.com>
Change log description
Convert to Docusaurus format.
Purpose of the change
Fixes #5889
What the code does
Allows Pravega docs to be rendered along with other docs as previewed here: https://pravega.io/docs/snapshot
Related PRs
pravega/docs#1
pravega/pravega-operator#594
pravega/spark-connectors#133
pravega/flink-connectors#594
pravega/schema-registry#239