Skip to content
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

Merged
merged 11 commits into from
Jan 15, 2019

Conversation

dpordomingo
Copy link
Contributor

@dpordomingo dpordomingo commented Jan 8, 2019

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, ):

  • 6a2c509 Documment config.yml.tpl main keys
  • a8b7144 When running source{d} Lookout with docker-compose, the default LOG_LEVEL is error
  • 399f7c7 Explain how to reload the config file.
  • 708bb9e Explain how to pass a valid GitHub user/token in Quickstart; what happens when source{d} Lookout is running properly and how to know it;

from TeamFocusMeeting

  • 9467e1f Explain the external dependencies: PostgreSQL, bblfsh and RabbitMQ.

from "new" PRs

other

  • db0ae73 Separate the two config methods: config.yml and .lookout.yml
  • 225bb49 Avoid user commiting .pem keys
  • 5519b73 Remove anchors that are not supported by GitBook
  • a1ebe26 Complete the explanation about how to use GitHub App authentication

@dpordomingo dpordomingo added enhancement New feature or request empathy-sessions Issue filed as as part of empathy sessions documentation Something related to project documentation labels Jan 8, 2019
@dpordomingo dpordomingo self-assigned this Jan 8, 2019
@dpordomingo dpordomingo force-pushed the docs-v3 branch 3 times, most recently from 9330d16 to 6a2c509 Compare January 8, 2019 18:48
@dpordomingo dpordomingo changed the title WIP docs enhancements Docs enhancements addressing empaty-sessions and others Jan 8, 2019
@dpordomingo dpordomingo changed the title Docs enhancements addressing empaty-sessions and others Docs enhancements for empathy-sessions and others Jan 8, 2019
@carlosms
Copy link
Contributor

carlosms commented Jan 9, 2019

what is TFM?

@dpordomingo
Copy link
Contributor Author

dpordomingo commented Jan 9, 2019

Team Focus Meeting (applications/2018-12-18-app-team-focus.md)

Copy link
Contributor

@carlosms carlosms left a 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

config.yml.tpl Outdated Show resolved Hide resolved
config.yml.tpl Outdated Show resolved Hide resolved
docker-compose.yml Outdated Show resolved Hide resolved
docs/architecture.md Outdated Show resolved Hide resolved
docs/architecture.md Outdated Show resolved Hide resolved
**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.
Copy link
Contributor

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.

Suggested change
- [`config.yml`](#config.yml), to define the global configuration of the server.
- [`config.yml`](#configyml), to define the global configuration of the server.

Copy link
Contributor Author

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?

Copy link
Contributor

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agree, issue created #469

docs/configuration.md Outdated Show resolved Hide resolved
docs/configuration.md Outdated Show resolved Hide resolved
docs/configuration.md Outdated Show resolved Hide resolved
docs/configuration.md Outdated Show resolved Hide resolved
Copy link
Contributor

@smacker smacker left a 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.

@dpordomingo
Copy link
Contributor Author

dpordomingo commented Jan 14, 2019

Thanks @carlosms for your detailed review (and sorry for making a big PR 😉)
I had to rebase to work over the new master (in order to take some of your latest changes, and also some from Vadim)
Your suggestions were addressed by 518d15f

Pending things that requires your feedback:



Signed-off-by: David Pordomingo <David.Pordomingo.F@gmail.com>
…e filter #lookout-sdk/44

Signed-off-by: David Pordomingo <David.Pordomingo.F@gmail.com>
Signed-off-by: David Pordomingo <David.Pordomingo.F@gmail.com>
Signed-off-by: David Pordomingo <David.Pordomingo.F@gmail.com>
Signed-off-by: David Pordomingo <David.Pordomingo.F@gmail.com>
Signed-off-by: David Pordomingo <David.Pordomingo.F@gmail.com>
Signed-off-by: David Pordomingo <David.Pordomingo.F@gmail.com>
Signed-off-by: David Pordomingo <David.Pordomingo.F@gmail.com>
…ssues/31

Signed-off-by: David Pordomingo <David.Pordomingo.F@gmail.com>
…sessions/issues/31

Signed-off-by: David Pordomingo <David.Pordomingo.F@gmail.com>
Signed-off-by: David Pordomingo <David.Pordomingo.F@gmail.com>
@dpordomingo dpordomingo merged commit ecac376 into src-d:master Jan 15, 2019
@dpordomingo dpordomingo deleted the docs-v3 branch January 15, 2019 11:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something related to project documentation empathy-sessions Issue filed as as part of empathy sessions enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants