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

OSS Gate Workshop: Tokyo: 2018-3-10: yoshitaku-jp: redash: Work log #744

Closed
yoshitaku-jp opened this issue Mar 10, 2018 · 43 comments
Closed

Comments

@yoshitaku-jp
Copy link
Contributor

This is a work log of a "OSS Gate workshop".
"OSS Gate workshop" is an activity to increase OSS developers.
Here's been discussed in Japanese. Thanks.

作業ログ作成時の説明

以下のテンプレートを埋めてタイトルに設定します。埋め方例はスクロールすると見えてきます。

OSS Gate Workshop: ${LOCATION}: ${YEAR}-${MONTH}-${DAY}: ${アカウント名}: ${OSS名}: Work log

タイトル例↓:

OSS Gate Workshop: Tokyo: 2017-01-16: kou: Rabbit: Work log

OSS Gateワークショップ関連情報

  • スライド:ワークショップの進行に使っているスライドがあります。
  • チャット:OSS開発に関することならなんでも相談できます。ワークショップが終わった後もオンラインで相談しながら継続的にOSSの開発に参加しましょう!
  • シナリオ:ワークショップの目的・内容・進め方の詳細が書いています。
  • 過去のビギナーの作業ログ:他の人の作業ログから学べることがいろいろあるはずです。
@y-goto
Copy link
Contributor

y-goto commented Mar 10, 2018

よろしくお願いします。

@yoshitaku-jp
Copy link
Contributor Author

よろしくおねがいします!

@yoshitaku-jp
Copy link
Contributor Author

redashを調べてみる

@chigix
Copy link
Contributor

chigix commented Mar 10, 2018

サポーターです、よろしくお願いします。

@yoshitaku-jp
Copy link
Contributor Author

よろしくおねがいします!

@yoshitaku-jp
Copy link
Contributor Author

検索結果の一番上にredashのサイトが出てきた
https://redash.io

@yoshitaku-jp
Copy link
Contributor Author

Get Startedがあったのでアクセスしてみる
ここに始めるための手順がありそう
https://redash.io/get-started/

@yoshitaku-jp
Copy link
Contributor Author

Plug and PlayとOpen Sourceがあった
SETUP GUIDEと書いてあるので更に進んで見る
https://redash.io/help-onpremise/setup/setting-up-redash-instance.html

@yoshitaku-jp
Copy link
Contributor Author

Setting up a Redash Instance
Create an Instanceとあって、AWS、Google Compute Engine、Docker Compose、Otherとあった

@yoshitaku-jp
Copy link
Contributor Author

ローカルマシーンでおこなうのでDocker Composeを使うことにする
Docker Composeのインストールからやってみることにする

@yoshitaku-jp
Copy link
Contributor Author

Docker Composeはインストール済みだった

@yoshitaku-jp
Copy link
Contributor Author

developer guideにアクセスする

@yoshitaku-jp
Copy link
Contributor Author

SetupにDocker Based Developer Installation Guide (recommended for beginners)とあったので、アクセスする

@yoshitaku-jp
Copy link
Contributor Author

Developer Installation Guide (recommended for experienced developers)もあるが、
ビギナーなのでDocker Based Developer Installation Guide (recommended for beginners)を選択する

@yoshitaku-jp
Copy link
Contributor Author

Docker Based Developer Installation Guideのsetup手順を開始する
https://redash.io/help-onpremise/dev/docker.html

@yoshitaku-jp
Copy link
Contributor Author

docker-compose.ymlを書く必要があるが、何を書くかが見当たらない?

@yoshitaku-jp
Copy link
Contributor Author

docker-compose.yml redashで検索してみる
githubが一番上にヒットする
この内容を使えば良さそう?
サイトの中にgithubへのリンクが有ると嬉しい

@yoshitaku-jp
Copy link
Contributor Author

github内のdocker-compose.ymlファイルの中身をコピー・アンド・ペーストし、
docker-compose.ymlを作成した

@yoshitaku-jp
Copy link
Contributor Author

docker-compose upをしてみる

@yoshitaku-jp
Copy link
Contributor Author

Creating network "redash_default" with the default driver
Building server
ERROR: Cannot locate specified Dockerfile: Dockerfile
が起きてしまった。

@yoshitaku-jp
Copy link
Contributor Author

Create Databaseの

# Create tables
docker-compose run --rm server create_db

を実行してみる

@yoshitaku-jp
Copy link
Contributor Author

Creating redash_redis_1 ... done
Creating redash_postgres_1 ... done
Building server
ERROR: Cannot locate specified Dockerfile: Dockerfile
が起きてしまった。

@yoshitaku-jp
Copy link
Contributor Author

Cannot locate specified Dockerfile: Dockerfile
について、調べてみる

@yoshitaku-jp
Copy link
Contributor Author

git clone [email protected]:getredash/redash.git
して、dockerファイルを含めてすべてをダウンロードする必要があるみたい?

@yoshitaku-jp
Copy link
Contributor Author

git clone https://github.com/getredash/redash.git
でクローンした
[email protected]:getredash/redash.git
だとsshの設定が必要だった

普段はgithub desktopを使っているから出来ていた?

@yoshitaku-jp
Copy link
Contributor Author

クローンが出来たので、改めてdocker-compose upをおこなう

@yoshitaku-jp
Copy link
Contributor Author

dockerが立ち上がったのでhttp://localhost:5000した

sqlalchemy.exc.ProgrammingError
ProgrammingError: (psycopg2.ProgrammingError) relation "organizations" does not exist
LINE 2: FROM organizations 
             ^
 [SQL: 'SELECT organizations.updated_at AS organizations_updated_at, organizations.created_at AS organizations_created_at, organizations.id AS organizations_id, organizations.name AS organizations_name, organizations.slug AS organizations_slug, organizations.settings AS organizations_settings \nFROM organizations \nWHERE organizations.slug = %(slug_1)s \n LIMIT %(param_1)s'] [parameters: {'slug_1': 'default', 'param_1': 1}]

が出た

@chigix
Copy link
Contributor

chigix commented Mar 10, 2018

getredash/redash#1480 (comment)

@yoshitaku-jp 多分そこに書いてある問題と同じかも。

@yoshitaku-jp
Copy link
Contributor Author

振り返り
コメントは編集できるので、後からでも追加すると良い

  • docker-compose upをするためのgit cloneが必要なことが明記されていないことがコントリビュート出来るポイント
  • New developer guideがあるので、そこに賛同するコメントをすることも良いこと

他の方の振り返り
フォークする時間を計測していた

@yoshitaku-jp
Copy link
Contributor Author

報告をする

  • 整理する
  • 開発者にとってわかりやすくなるように編集
  • 適切な場所に報告

@yoshitaku-jp
Copy link
Contributor Author

まずは伝えたいことを整理する

@yoshitaku-jp
Copy link
Contributor Author

  • docker-compose upをするためのgit cloneが必要なことが明記されていないことがコントリビュート出来るポイント
    こちらについて書いてみる

https://redash.io/help-onpremise/dev/docker.html

@yoshitaku-jp
Copy link
Contributor Author

yoshitaku-jp commented Mar 10, 2018

ページ内で

Setup

Create Docker Services

Once you have the above setup, you need to create the Docker services:
docker-compose up
This will build the Docker images and fetch some prebuilt images and then start the services (Redash web server, worker, PostgreSQL and Redis). You can refer to the docker-compose.yml file to see the full configuration.

と記述してあるが、docker-compose upをする前に、
https://github.com/getredash/redash
をクローンしてくることが書いていない

その記述がある方が、ビギナー向け記事としては良いと思うので、
そのことを追記した方がいい旨を書く

@yoshitaku-jp
Copy link
Contributor Author

そもそもDocker Based Developer Installation Guide (recommended for beginners)ページの
recommended for beginnersが、誰を指しているのか。
本当の何もかもの初心者なのか、redashを使ったことがないだけでdockerについての知識はある人なのか
考える必要もあるのかも。

@yoshitaku-jp
Copy link
Contributor Author

https://redash.io/help-onpremise/setup/setting-up-redash-instance.html

Docker Compose
Make sure your current working directory is the root of this GitHub repository.
とあるので、
githubからcloneするか、dockerhubから落としてくるのかの議論があったが、
githubからcloneする方法のみを追記してほしい旨を伝えることにする

@yoshitaku-jp
Copy link
Contributor Author

dockerでredashを使用するためには、ローカルに落としてくる必要がある

  • GitHubからcloneする

GitHubからcloneする

git clone [email protected]:getredash/redash.git
cd redash/
docker-compose up

とすれば適切?

@yoshitaku-jp
Copy link
Contributor Author

コマンドを一緒にした方がいいかと思ったが、
Create Docker Servicesの項にいれるのは適切ではないので、
git cloneをする 項を新しく作る
git clone [email protected]:getredash/redash.git
ほうがいい

@yoshitaku-jp
Copy link
Contributor Author

ここからフィードバックする内容(日本語

redashをクローンする

まずはredashをGitHubからクローンする

git clone [email protected]:getredash/redash.git
cd redash/

@yoshitaku-jp
Copy link
Contributor Author

Git Clone Redash

At the beginning clone Redash from GitHub

git clone [email protected]:getredash/redash.git
cd redash/

@yoshitaku-jp
Copy link
Contributor Author

yoshitaku-jp commented Mar 10, 2018

  • 一番上のところはコマンドを書くわけではないので、一旦やめてみる
  • 他の項目が動詞から始まっているので、動詞で初めてみる
    • Prepare The Source code とか
  • 説明文も、コマンドを繰り返す必要がなく、何をするのかを簡潔に説明する
    • Firstly, you need to setup the source code directory from the official repository. とか

Prepare The Source code

Firstly, you need to setup the source code directory from the official repository.

git clone [email protected]:getredash/redash.git
cd redash/

@yoshitaku-jp
Copy link
Contributor Author

プルリクエストをしてみた
getredash/website#65

@yoshitaku-jp
Copy link
Contributor Author

  • git プロトコルをあまり使うべきではない
    • httpsやsshのほうがいい
  • なぜ必要になったのかの説明を書いたほうがいい
    • 人によっては聞かれる
  • コミットメッセージをもっと伝わりやすく

今後

  • push -fでプルリクエストを修正する

他の方の振り返り

  • 日本語でちゃんと論理建ててみる
  • 簡単な英語でいいからまずは伝わる英語で表現してみる
  • 第二文系でまずは考える
    • 「です」「ます」調に近いから

@kou
Copy link
Member

kou commented Apr 12, 2018

お疲れ様でした!

@kou kou closed this as completed Apr 12, 2018
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

No branches or pull requests

4 participants