From 6a8afd2f69a13f62841a3fe909beaad96928fadb Mon Sep 17 00:00:00 2001 From: thea Date: Thu, 15 Sep 2016 12:23:14 +0200 Subject: twitter readme now contains github markup to show secrets-file content --- doc/TWITTER_FEED.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'doc/TWITTER_FEED.md') diff --git a/doc/TWITTER_FEED.md b/doc/TWITTER_FEED.md index dd3954c..221c334 100644 --- a/doc/TWITTER_FEED.md +++ b/doc/TWITTER_FEED.md @@ -19,6 +19,18 @@ LEAP web app (as part of the main view). * Activate the feature within your local LEAP Web Application * If not already existing create a secrets-file in /config with the name secrets.yml (`/config/secrets.yml`) * Secrets-file should contain the following, make sure its in YAML: {"development"=> {"twitter"=>{"enabled"=>false, "twitter_handle"=>"", "bearer_token"=>"", "twitter_picture"=>nil}}, "test"=>{"twitter"=>{"enabled"=>false, "twitter_handle"=>"", "bearer_token"=>"", "twitter_picture"=>nil}}} +``` +development: + twitter: + enabled: false # set to true for usage + twitter_handle: XXXXX #put your twitter handle here + bearer_token: XXXXX #put your bearer token here +test: + twitter: + enabled: false # set to true for usage + twitter_handle: XXXXX #put your twitter handle here + bearer_token: XXXXX #put your bearer token here +``` * To have your bearer token created, run script in terminal being in the file of leap_web: `script/generate_bearer_token` * To have the script run properly you have to add before running: `--key your_consumerkey --secret your_consumersecret` * Add also `--projectroot your_projectroot --twitterhandle your_twitterhandle` as well to not have manually put the data in your secrets-file -- cgit v1.2.3 From 94a5b32a58f5f4fb63eaf677a91af63e1fe3e325 Mon Sep 17 00:00:00 2001 From: thea Date: Thu, 15 Sep 2016 15:29:10 +0200 Subject: included production for readme & secrets --- doc/TWITTER_FEED.md | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'doc/TWITTER_FEED.md') diff --git a/doc/TWITTER_FEED.md b/doc/TWITTER_FEED.md index 221c334..592cd38 100644 --- a/doc/TWITTER_FEED.md +++ b/doc/TWITTER_FEED.md @@ -30,6 +30,11 @@ test: enabled: false # set to true for usage twitter_handle: XXXXX #put your twitter handle here bearer_token: XXXXX #put your bearer token here +production: + twitter: + enabled: false # set to true for usage + twitter_handle: XXXXX #put your twitter handle here + bearer_token: XXXXX #put your bearer token here ``` * To have your bearer token created, run script in terminal being in the file of leap_web: `script/generate_bearer_token` * To have the script run properly you have to add before running: `--key your_consumerkey --secret your_consumersecret` -- cgit v1.2.3 From d44fc9292637ed6d1a4a7e04883e8b3b88dc3c15 Mon Sep 17 00:00:00 2001 From: theaamanda Date: Wed, 21 Sep 2016 23:34:53 +0200 Subject: finished error-handling with different error-messages for different errors. added info that the account has to be public in Twitter-Doc --- doc/TWITTER_FEED.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/TWITTER_FEED.md') diff --git a/doc/TWITTER_FEED.md b/doc/TWITTER_FEED.md index 592cd38..94de8c1 100644 --- a/doc/TWITTER_FEED.md +++ b/doc/TWITTER_FEED.md @@ -41,7 +41,7 @@ production: * Add also `--projectroot your_projectroot --twitterhandle your_twitterhandle` as well to not have manually put the data in your secrets-file * The full command looks like this: `script/generate_bearer_token --key your_consumerkey --secret your_consumersecret --projectroot your_projectroot --twitterhandle your_twitterhandle` * If you didn't give all your information to the script, had a typo or want to change anything else, please do so by finding the secrets-file at `/config/secrets.yml` - * Make sure that the correct twitterhandle and bearer-token is included + * Make sure that the correct twitterhandle and bearer-token is included. The twitter-account you want to have shown (the twitterhandle) is a public account! * Deactivate your bearer token * To deactivate your generated bearer token you can run script/invalidate_bearer_token -- cgit v1.2.3 From 4ffa776d2c760618b17bd76a9a023f7fe762babd Mon Sep 17 00:00:00 2001 From: luca-marie Date: Fri, 23 Sep 2016 11:52:46 +0200 Subject: Doc updated on how to customize avatar picture in twitter feature; update error response messages; added 'config/customization/images' + link in 'config/initializer/customization.rb' --- doc/TWITTER_FEED.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'doc/TWITTER_FEED.md') diff --git a/doc/TWITTER_FEED.md b/doc/TWITTER_FEED.md index dd3954c..3e54a4d 100644 --- a/doc/TWITTER_FEED.md +++ b/doc/TWITTER_FEED.md @@ -24,7 +24,7 @@ LEAP web app (as part of the main view). * Add also `--projectroot your_projectroot --twitterhandle your_twitterhandle` as well to not have manually put the data in your secrets-file * The full command looks like this: `script/generate_bearer_token --key your_consumerkey --secret your_consumersecret --projectroot your_projectroot --twitterhandle your_twitterhandle` * If you didn't give all your information to the script, had a typo or want to change anything else, please do so by finding the secrets-file at `/config/secrets.yml` - * Make sure that the correct twitterhandle and bearer-token is included + * Make sure that the correct twitter handle and bearer token is included * Deactivate your bearer token * To deactivate your generated bearer token you can run script/invalidate_bearer_token @@ -32,4 +32,5 @@ LEAP web app (as part of the main view). ### Default avatar image ### -This feature uses by default the twitter bird as avatar picture (Twitter_Logo_Blue.png). By using the Twitter trademarks, you agree to follow the Twitter Trademark Guidelines as well as Twitter's Terms of Service and all other Twitter rules and policies. Please find more details here: https://brand.twitter.com/. +This feature uses by default the twitter bird as avatar picture, you can find here (app/assets/images/Avatar_Pic.png). For customization you can upload your own avatar picture to 'config/customization/images' naming the image file 'Avatar_Pic.png'. This will replace the default image file. +By using the Twitter trademarks, you agree to follow the Twitter Trademark Guidelines as well as Twitter's Terms of Service and all other Twitter rules and policies. Please find more details here: https://brand.twitter.com/. -- cgit v1.2.3 From 69b182b1bf811e1d09c734debf0f71f8412dd6b7 Mon Sep 17 00:00:00 2001 From: luca-marie Date: Fri, 23 Sep 2016 16:56:58 +0200 Subject: Adapted description to use case 'tweets are protected' --- doc/TWITTER_FEED.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/TWITTER_FEED.md') diff --git a/doc/TWITTER_FEED.md b/doc/TWITTER_FEED.md index 552dc54..6deb432 100644 --- a/doc/TWITTER_FEED.md +++ b/doc/TWITTER_FEED.md @@ -41,7 +41,7 @@ production: * Add also `--projectroot your_projectroot --twitterhandle your_twitterhandle` as well to not have manually put the data in your secrets-file * The full command looks like this: `script/generate_bearer_token --key your_consumerkey --secret your_consumersecret --projectroot your_projectroot --twitterhandle your_twitterhandle` * If you didn't give all your information to the script, had a typo or want to change anything else, please do so by finding the secrets-file at `/config/secrets.yml` - * Make sure that the correct twitter-handle and bearer-token is included. The tweets of the twitter-account you want to have shown have to be public! + * Make sure that the correct twitter-handle and bearer-token is included. The account's tweets must not be protected, otherwise they cannot be displayed. * Deactivate your bearer token * To deactivate your generated bearer token you can run script/invalidate_bearer_token -- cgit v1.2.3