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

Sync docs to website #2378

Merged
merged 6 commits into from
Jul 21, 2020
Merged

Sync docs to website #2378

merged 6 commits into from
Jul 21, 2020

Conversation

robbymilo
Copy link
Contributor

@robbymilo robbymilo commented Jul 20, 2020

What this PR does / why we need it:

Updates the docs to work with the website. Adds a GitHub action to sync the docs to the website repo.

Note that the actual content of the docs moves down one directory level to sources as symlinking _index.md to README.md duplicates the page in the hugo build. Instead, I've kept docs/README.md the same and have updated links.

See https://github.com/grafana/website/pull/1837.

Todo:

  • Add grafanabot personal access token GH_BOT_ACCESS_TOKEN as a secret in this repo

@CLAassistant
Copy link

CLAassistant commented Jul 20, 2020

CLA assistant check
All committers have signed the CLA.

# Conflicts:
#	docs/README.md
#	docs/sources/operations/upgrade.md
@codecov-commenter
Copy link

codecov-commenter commented Jul 20, 2020

Codecov Report

Merging #2378 into master will decrease coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2378      +/-   ##
==========================================
- Coverage   61.65%   61.62%   -0.03%     
==========================================
  Files         160      160              
  Lines       13565    13565              
==========================================
- Hits         8363     8360       -3     
- Misses       4579     4580       +1     
- Partials      623      625       +2     
Impacted Files Coverage Δ
pkg/promtail/targets/file/tailer.go 73.86% <0.00%> (-4.55%) ⬇️
pkg/promtail/targets/file/filetarget.go 68.67% <0.00%> (-1.81%) ⬇️
pkg/logql/evaluator.go 92.88% <0.00%> (+0.40%) ⬆️
pkg/querier/queryrange/downstreamer.go 97.93% <0.00%> (+2.06%) ⬆️

Copy link
Contributor

@oddlittlebird oddlittlebird left a comment

Choose a reason for hiding this comment

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

Huzzah!

Copy link
Member

@owen-d owen-d left a comment

Choose a reason for hiding this comment

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

This looks great. Can you add .DS_Store to .gitignore and remove the file from git?

@robbymilo
Copy link
Contributor Author

This looks great. Can you add .DS_Store to .gitignore and remove the file from git?

Yep, removed.

@slim-bean
Copy link
Collaborator

This is awesome @robbymilo very excited!

Copy link
Collaborator

@slim-bean slim-bean left a comment

Choose a reason for hiding this comment

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

LGTM

@robbymilo robbymilo merged commit 5a8bc84 into master Jul 21, 2020
@robbymilo robbymilo deleted the robbymilo/docs branch July 21, 2020 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants