Commit graph

42 commits

Author SHA1 Message Date
Andrew Bone
393f2d09af
Change admin password in docs (#10735)
Update default admin password in documentation
2020-10-08 09:28:05 -05:00
Josh Puetz
c0272357c0
Add default admin to seeds file (#10620)
* Add default admin to seeds file

* Docs
2020-10-06 08:25:25 -05:00
Rafi
8e46763a49
Adding note about branch naming (#10320) 2020-09-15 16:37:12 -05:00
Kevin McGinn
3bce753303
[Documentation] Improvements to Windows installation & startup docs (#10243)
* fix elasticsearch tgz filename in windows docs

* add prereqs to running bin/startup in windows docs

* add tip for Sidekiq errors in app startup docs
2020-09-09 18:19:16 -04:00
Ben Halpern
dba151915b
[deploy] Allow initial user to sign up and configure app (#10073)
* Allow initial user to sign up and configure app

* Fix added value unneeded

* Make siteconfig public in tests

* Remove deprecated method and adjust seed default

* Add new controllers not to redirect for public

* Modify tests

* Edit test defaults

* Fix linting

* Add starter mode to seed file
2020-08-31 12:54:22 -04:00
Josh Puetz
d47d02f090
[deploy] Log in with Facebook (#9922)
* First draft of facebook auth

* Add Facebook welcome broadcast to seeds, data script

* Tests!

* Documentation

* Update docs with pictures

* User siteconfig/app config

* Adjust dropdown menu width to avoid wrap for Facebook button

* Add Facebook auth keys to SiteConfig properly

* Remove unnecessary VCR cassette

* Add omniauth facebook gem to vendor cache

* Use uid instead of email for nickname randomization

* Test fix, test for missing email in Facebook

* Update docs/backend/auth-facebook.md

Co-authored-by: Molly Struve <mollylbs@gmail.com>

* Typo fix!

* Don't default facebook auth settings to ApplicationConfig

Co-authored-by: Molly Struve <mollylbs@gmail.com>
2020-08-26 12:04:20 -04:00
Ben Halpern
36ccfd55dd
[deploy] Add Twitter and GitHub keys to SiteConfig (#9899)
* Add Twitter and GitHub keys to SiteConfig

* Change docs

* Add notice about not taking affect right away
2020-08-20 15:58:15 -04:00
Vaidehi Joshi
1531c182cc
Move .env_sample out of /config directory (#9868)
The `.env` file shouldn't live in the `/config` directory when it is created, but
currently, the `.env_sample` file lives within `/config`. This can be confusing and
cause ENV var issues if someone duplicates `.env_sample` and renames it to `.env`,
because none of their ENV variables will get picked up, since their `.env` file will
mistakenly end up in `/config`.

This change moves `.env_sample` out of `/config`, and updates the documentation/relevant
.yml files accordingly.
2020-08-19 18:18:30 +02:00
Molly Struve
0a64ac067b
[deploy] Remove ENVied Gem, Use dotenv Take 2 (#9767) 2020-08-14 12:20:47 -05:00
rhymes
e727956640
Revert "[deploy] Refactor:Remove ENVied Gem, Use dotenv Instead for Test and Development (#9621)" (#9757)
This reverts commit 1be8c72206.
2020-08-12 13:28:38 -04:00
Molly Struve
1be8c72206
[deploy] Refactor:Remove ENVied Gem, Use dotenv Instead for Test and Development (#9621)
* Refactor:Remove ENVied Gem in Favor of Default application.yml

* Copy sample_application.yml for Travis

* Create .env_sample file, Warn of missing ENV variables, ignore .env file

* Use dotenv For ENV variables and create Rake Task to Populate

* Update docs to copy .env_sample file

* make application config a bit more resilient

* update more documentation and only initialize dotenv in dev and test

* Update doc code snippet types and refactor rake task and app config

* remove push defaults

* Make initializers more resilient, remove unused ENV from travis

* Exit new rake task if application.yml does not exist, include dotenv in docs
2020-08-12 11:01:38 -04:00
Andy Zhao
955bdcb2bc
Update docs with Forem instead of dev.to (#9316)
* Rename all GitHub links from thepracticaldev/dev.to to forem/forem

* Use new site name

* Rename to Forem

* Rename more dev.to to forem

* Remove unnecessary redirects

* Rename DEV to Forem

* Use Forem instead of DEV for branding

* Use Forem instead of DEV for licensing

* Use seedling instead of DEV logo
2020-07-15 13:29:11 -04:00
Nick Taylor
6bcdae3712
Configure eslint to use Preact linter rules (#8828) 2020-06-22 14:44:55 -04:00
Dmitry Maksyoma
cc0254310c
Update docs to shine more light on bin/setup and bin/startup (#8290) 2020-06-05 12:21:53 -04:00
Molly Struve
4c779be2ed
[deploy] Remove ALL Algolia Code (#7577) 2020-04-29 10:11:57 -05:00
Ridhwana
813389d36a
Keeping your forked branch up to date (#6531)
* chore: updates to sync your forked ranch

* chore: use rease instead

* feat: update the script to not bomb out if you have added the remote before

* chore: add the comment back
2020-03-09 09:37:46 -04:00
rhymes
f14b5f93fe
Update README and contributing guide (#6074)
* Update readme

* Update contributing guide

* Update prepare PR guides to mention draft PRs
2020-02-17 11:53:49 -05:00
Molly Struve
6a277ba10d
remove rake jobs:work references from code (#6082) [deploy] 2020-02-14 15:18:08 -05:00
Alex
b81c2e8df3
Remove delayed_job (#6071) [deploy]
* Update adapter to sidekiq

* Remove delayed_jobs routes

* Remove delayd_jobs initializer and references

* Remove delayed_job_spec

* Remove bin/delayed_job

* Remove app/jobs/

* Migration to drop delayed_jobs table

* Remove delayed_job_web & delayed_job_active_record

* Update docs

* Remove reference to delayed_job dashboard

* Remove delayed_job settings from initializers

* Add delayed_job_admin back to reserved words list
2020-02-14 10:00:26 -08:00
rhymes
085c0d1e01
Add multiplier for seeds and use it for articles and users (#6003)
* Add seeds multiplier and use it for articles and users

* Update DB documentation
2020-02-10 16:06:58 -05:00
Nick Taylor
17a5e831fd
Added a section about increasing seed data. (#5948) 2020-02-07 10:36:43 -05:00
Viraj Chavan
4ca5932dc0
Fixes the link 'Other tools' in docs (on /getting-started/start-app/) (#5935)
* Fixes the link 'Other tools'

* Update docs/getting-started/start-app.md

Co-Authored-By: rhymes <rhymesete@gmail.com>

Co-authored-by: rhymes <rhymesete@gmail.com>
2020-02-06 19:20:13 -06:00
Josh Puetz
af9c4832c5
Correct startup script and docs (#5940) 2020-02-06 17:04:54 -05:00
Michael Kohl
424c141539
Remove Foreman gem (#5821) 2020-02-05 17:01:04 -05:00
rhymes
7c94c8955a Update branching docs [ci skip] (#5666)
* Fix contributing guide TOC

* Sync branching docs with contributing guide

* Write about writing meaningful commit messages
2020-01-23 09:28:46 -05:00
Vaidehi Joshi
75dafe66da
Add note to help debug bin/setup issues. (#5651)
When starting the app for the first time, it's possible to run into some issues while trying to run `bin/setup`.
For example, when I started the app, I got an (unhelpful) error when running `bin/setup` and ended up figuring out the issue (needing to `yarn install`) by running the contents of the Procfile.dev file directly.

We should help point folks to this file so that they can run a command that gives them a more helpful error message, which should hopefully let them get the app up and running with any problems! :)
2020-01-22 14:37:08 -08:00
Shelley Vohr
b146528aa8 feat: add per-user Open Dyslexic font setting (#5037) [deploy]
* feat: add per-user Open Dyslexic font setting

* Adjust css slightly

Co-authored-by: Ben Halpern <bendhalpern@gmail.com>
2020-01-20 18:23:57 -05:00
Robin
d7174923a2 Git scripts to sync or reset repository fork (#5055)
* Add script to clean / reset the fork and start from upstream

* Add script to sync fork with latest changes from upstream

* Remove swap file accidentially checked in

* Add exit on break to shell scripts and documentation of shell scripts to workflow-suggested workflow

Co-authored-by: Mac Siri <krairit.siri@gmail.com>
2019-12-30 13:58:16 -05:00
Jacob Herrington
7d0aeeefe5 Improve the clarity of the docs and fix Prettier config (#4899)
* Improve format and clarity of the docs [ci skip]

While this change produces a lot of git noise by enacting what seems
like an arbitrary linewrap on most of the files in the documentation it
will result in better version control and tracking of the changes in the
documentation.

For example, as it currently stands, if one was to make a
PR to move a comma in a sentence because each paragraph in most of the
files is on a single line, that small change would look in the git
history like the author had modified the entire paragraph. In reality,
this author just moved a comma.

This change also includes a significant number of modifications to the
more article-esque docs. Many of these docs were written in a sort of
stream-of-conciousness and aren't as easy to read as they could be.
Hopefully this is the first of several readability changes. If we could
get these docs to a more accessible reading level, we would probably see
an increase in contributions. :)

* Delegate markdown wrapping to Prettier

* Add linewrapping explanation in the docs [ci skip]
2019-11-26 08:40:53 -05:00
rhymes
1924a77a10 [DOC] Move architecture to technical overview (#4746) 2019-11-07 14:28:23 -05:00
Jenna Pederson
ee91310f3a Doc: Fix/clarify getting started docs (#4509) [ci skip] 2019-10-22 14:38:41 -04:00
Anna Anks Nowak
c4b5530e2e Add info about bumping API version to docs.dev (#4454)
* Add views count for authenticated users articles [#4250]

* Bump API version to 0.5.6 [#4250]

* Add info about bumping API docs version requirement

* Fix Create pull request link by linking to the docs
2019-10-16 09:04:36 -04:00
Ben Halpern
3db3f6fdc2
Fix gotchas with color preview and some style adjustments and add documentation (#4322) 2019-10-08 21:32:31 -04:00
Ben Halpern
c0faa20c90
Add more info to architecture (#4233)
* Add more info to architecture

* Fix various typos and improve clarity in docs
2019-10-08 11:29:44 -04:00
Jacob Herrington
8cebfd415d [DOC] Update DEV onboarding documentation (#4215) 2019-10-03 16:38:28 -04:00
Jacob Herrington
4ea1e6e020 Fix typos and mechanical mistakes (#4177) [ci skip] 2019-10-01 16:30:13 -04:00
Ben Halpern
cbef9ada79
Add some architecture docs (#4171) 2019-10-01 10:30:03 -04:00
Jess Lee
8e53ef0d8e clean up readme and docs (#3660)
* clean up readme and docs

* add missing files
2019-08-08 16:20:58 -03:00
Kitten King
6290451273 Fix Typos (#3510) 2019-07-22 12:56:48 -04:00
Conor Fischer
2a57e43bcb Fix broken doc links (#2945) [ci skip] 2019-05-24 12:31:18 -04:00
rhymes
9210f6793b Improvements on dev docs (#2616)
* Correct installation documentation

* Add stylized titles

* Add some changes to the getting started documentation

* Add changes for the backend guide

* Add changes for the design guide

* Add testing / Q&A guide improvements

* Minor fixes to contributing docs

* More improvements to the general doc

* Improvements for frontend guide
2019-04-29 18:54:29 -04:00
Andrew Brown
30dcb23169 #2507 - refactor GitDocs documentation (#2595)
* #2507 - refactor GitDocs documentation

* #2507 - fix grammar and spelling errors
2019-04-29 10:08:22 -04:00