Skip to content

Fix/add links in READMEs #448

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
norbertklawikowski merged 1 commit into from
Apr 10, 2024
Merged

Fix/add links in READMEs #448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions examples/4-tests/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,4 @@

This Example demonstrates the testing capabilities of the tester package.

Check the source file to get the examples
https://github.com/lovoo/goka/blob/master/examples/4-tests/example_test.go
Check the [source file](https://github.com/lovoo/goka/blob/master/examples/4-tests/example_test.go) to get the examples.
6 changes: 3 additions & 3 deletions examples/8-monitoring/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ go proc.Run(context.Background())
http.ListenAndServe(":9095", root)
```

Opening the browser on [localhost:9095/monitor/]() will then show us a list of all attached processors
Opening the browser on [localhost:9095/monitor/](http://localhost:9095/monitor/) will then show us a list of all attached processors
and views and by selecting one of them we'll get statistics of the processor, similar like this

![Processor View](images/processor-view.png?raw=true "processor view")
Expand All @@ -49,7 +49,7 @@ idxServer := index.NewServer("/", root)
idxServer.AddComponent(monitorServer, "Monitor")
```

So next time we open the page at [localhost:9095](), we'll get some nice links to the monitor.
So next time we open the page at [localhost:9095](http://localhost:9095), we'll get some nice links to the monitor.

![Index](images/index.png?raw=true "index view")

Expand All @@ -73,7 +73,7 @@ Voila!

## Example

The example in [main.go]() demonstrates the concepts and typical applications of the web interface by
The example in [main.go](https://github.com/lovoo/goka/blob/master/examples/8-monitoring/main.go) demonstrates the concepts and typical applications of the web interface by
creating an Emitter, multiple Processors and a web interface.

Be sure to have Apache Kafka and Zookeeper running by starting it in the examples-folder.
Expand Down
6 changes: 3 additions & 3 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This is a very simple toy application that demonstrates how to

### Clicks
Similar to the first example, Emitter, Processor and View are demonstrated here.
In Addition it shows how to
In addition, it shows how to

* access the View using a web endpoint
* use a Codecs
Expand All @@ -39,7 +39,7 @@ The following examples show the combination of multiple processors, views, etc.

By generating a random folder for storage, this example can be executed in parallel multiple times to get a feeling for the rebalancing that's happening under the hood.

[Example]https://github.com/lovoo/goka/tree/master/examples/5-multiple/)
[Example](https://github.com/lovoo/goka/tree/master/examples/5-multiple/)


### Monitoring
Expand All @@ -57,4 +57,4 @@ Shows how to (unit-)test programs using goka.

Demonstrates the rather new context function to defer (postpone) the commit of a callback.

[Example](https://github.com/lovoo/goka/tree/master/examples/9-defer-commit)
[Example](https://github.com/lovoo/goka/tree/master/examples/9-defer-commit)