Skip to content

Commit 0d2454c

Browse files
ravisuhaggitbook-bot
authored andcommitted
GitBook: [main] 3 pages and one asset modified
1 parent 54cd0f9 commit 0d2454c

File tree

4 files changed

+138
-9
lines changed

4 files changed

+138
-9
lines changed

docs/.gitbook/assets/overview.svg

Lines changed: 129 additions & 0 deletions
Loading

docs/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
Columbus is a search and discovery engine built for querying application deployments, datasets and meta resources. It can also optionally track data flow relationships between these resources and allow the user to view a representation of the data flow graph.
44

5-
![](./assets/overview.svg)
5+
![](.gitbook/assets/overview.svg)
66

77
## Key Features
8+
89
Discover why users choose Columbus as their main data discovery and lineage service
910

1011
* **Full text search** Faster and better search results powered by ElasticSearch full text search capability.
@@ -18,9 +19,8 @@ Discover why users choose Columbus as their main data discovery and lineage serv
1819

1920
Explore the following resources to get started with Columbus:
2021

21-
* [Guides](./guides) provides guidance on ingesting and queying metadata from Columbus.
22-
* [Concepts](./concepts) describes all important Columbus concepts.
23-
* [Reference](./reference) contains details about configurations, metrics and other aspects of Columbus.
24-
* [Contribute](./contribute/contribution.md) contains resources for anyone who wants to contribute to Columbus.
25-
22+
* [Guides](https://github.com/odpf/columbus/tree/1093c7e9a2c862b0b1dbd45812e7c3837125ef79/docs/guides/README.md) provides guidance on ingesting and queying metadata from Columbus.
23+
* [Concepts](https://github.com/odpf/columbus/tree/1093c7e9a2c862b0b1dbd45812e7c3837125ef79/docs/concepts/README.md) describes all important Columbus concepts.
24+
* [Reference](https://github.com/odpf/columbus/tree/1093c7e9a2c862b0b1dbd45812e7c3837125ef79/docs/reference/README.md) contains details about configurations, metrics and other aspects of Columbus.
25+
* [Contribute](https://github.com/odpf/columbus/tree/1093c7e9a2c862b0b1dbd45812e7c3837125ef79/docs/contribute/contribution.md) contains resources for anyone who wants to contribute to Columbus.
2626

docs/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
* [Introduction](README.md)
44
* [Roadmap](roadmap.md)
5-
* [Changelog](https://github.com/odpf/columbus/changelog.md)
5+
* [Changelog](https://github.com/odpf/columbus/blob/main/CHANGELOG.md)
66

77
## Guides
88

docs/guides/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## Requirements
44

5-
Columbus is written in golang, and requires go version >= 1.13. Please make sure that the go tool chain is available on your machine. See golang’s [documentation](https://golang.org/) for installation instructions.
5+
Columbus is written in Golang, and requires go version >= 1.13. Please make sure that the go toolchain is available on your machine. See Golang’s [documentation](https://golang.org/) for installation instructions.
66

7-
Alternatively, you can use docker to build columbus as a docker image. More on this in the next section.
7+
Alternatively, you can use docker to build Columbus as a docker image. More on this in the next section.
88

99
Columbus uses elasticsearch v7 as the query and storage backend. In order to run columbus locally, you’ll need to have an instance of elasticsearch running. You can either download elasticsearch and run it manually, or you can run elasticsearch inside docker by running the following command in a terminal
1010

0 commit comments

Comments
 (0)