-
Notifications
You must be signed in to change notification settings - Fork 36
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.
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
Docs enhancements for empathy-sessions and others #450
Conversation
9330d16
to
6a2c509
Compare
what is TFM? |
Team Focus Meeting (applications/2018-12-18-app-team-focus.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have to say, smaller PRs would be much easier to review
docs/configuration.md
Outdated
**source{d} Lookout** is configured with the `config.yml` file, you can use the template [`config.yml.tpl`](/config.yml.tpl) to create your own. Use the `lookoutd` option `--config` to set the path to it, or use the default location at `./config.yml`. | ||
The behavior of **source{d} Lookout** is configured with two different configuration files: | ||
|
||
- [`config.yml`](#config.yml), to define the global configuration of the server. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Link does not work, at least in GitHub, I don't know about Gitbook.
- [`config.yml`](#config.yml), to define the global configuration of the server. | |
- [`config.yml`](#configyml), to define the global configuration of the server. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I asumed GitBook as the preferred way to render our docs, and it works differently when creating anchors for titles having .
inside.
- Title:
config.yml
- GitBook:
#config-yml
- GitHub:
#configyml
In case it is required to support both, would you propose an alternative?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For this PR it would be fine if it only works on GitBook, in my opinion. But if the section links do not work on GitHub let's at least open an issue and try to fix it at some point. Maybe we just need to assume the limitations and avoid .
in titles.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agree, issue created #469
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are 2 points I think we should change but because Carlos already mentioned and tracks them I approve.
7b9a7ae
to
518d15f
Compare
Thanks @carlosms for your detailed review (and sorry for making a big PR 😉) Pending things that requires your feedback:
|
Signed-off-by: David Pordomingo <[email protected]>
…e filter #lookout-sdk/44 Signed-off-by: David Pordomingo <[email protected]>
Signed-off-by: David Pordomingo <[email protected]>
Signed-off-by: David Pordomingo <[email protected]>
Signed-off-by: David Pordomingo <[email protected]>
Signed-off-by: David Pordomingo <[email protected]>
Signed-off-by: David Pordomingo <[email protected]>
Signed-off-by: David Pordomingo <[email protected]>
…ssues/31 Signed-off-by: David Pordomingo <[email protected]>
8b14a9e
to
1470516
Compare
…sessions/issues/31 Signed-off-by: David Pordomingo <[email protected]>
Signed-off-by: David Pordomingo <[email protected]>
These are many improvements made to the docs considering different inputs; each case is separated in a different commit.
In case you want to exclude any of the changes, or discuss in a separate PR, just say so and I'll extract it.
from empathy sessions (Miguel's#28, Michael's#31, Juanjo's#24, ):
config.yml.tpl
main keysdocker-compose
, the defaultLOG_LEVEL
iserror
from TeamFocusMeeting
from "new" PRs
SUMMARY.md
)other
config.yml
and.lookout.yml