Commit graph

113 commits

Author SHA1 Message Date
Mazen Touati
ed3d8901b2
Update Readme (#9333)
Co-authored-by: Ben Halpern <bendhalpern@gmail.com>
2020-07-16 10:26:25 -04:00
Christina
73187e82ba
Add missing words in README (#9341)
Adding in missing word `write` to the forem/README.md file.
2020-07-16 09:49:16 +02:00
Andy Zhao
3b73038919
Update more Forem to DEV language (#9337)
* Update more Forem to DEV language

* Update readme with more Forem language

* Use Forem favicon, thanks @atsmith813!
2020-07-15 18:01:34 -04:00
Ben Halpern
df273b62e1
Update Readme Headline (#9309) 2020-07-14 14:45:45 -04:00
Molly Struve
fde4d3f189
Update Docs, Travis, and Containers to Use Postgres 11 (#9232)
* Update Docs and Containers to Use Postgres 11<, Bump Travis to 10

* Update installation docs as well

Co-authored-by: rhymes <rhymes@hey.com>
2020-07-13 15:09:26 +02:00
Molly Struve
2aeebcda5a
Documentation: Add More Knapsack Information to Docs (#8419)
Co-authored-by: Mac Siri <krairit.siri@gmail.com>
Co-authored-by: Vaidehi Joshi <vaidehi.sj@gmail.com>
2020-06-11 17:50:32 -05:00
Joe Doss
aa49cb1cfe
Bugfix for #7663 and refactor of container setup (#7747)
* Move from Alpine Linux to Fedora Linux.

This changes the base container image away from Alpine Linux to
Fedora Linux to address some musl libc issues with some of our gems.

It also moved the main file to a Containerfile and symlinks the Dockerfile
to it. This makes our container setup less Docker-centric as Linux users
most likely will be using Podman as their container runtime.

Lastly, it moves the WORKDIR from /usr/src/app to /opt/apps/devto.
The Linux FHS states that /opt is the spot for Optional application
software packages and /usr/src is for kernel source code.

https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard

/opt Optional application software packages
/usr/src Source code, e.g., the kernel source code with its header files.

Also, if SELinux becomes a thing in our future, moving this makes it
easier to manage contexts out of /opt rather than /usr/src.

* Adjust the Containerfile a bit to add some missing packages, make it
more generic and move env vars to the docker-compose.

* Move the Dockerfile to a symlink to the Containerfile.

We need to be able to support more than just Docker for a container
runtime. Moving everything to a Containerfile and symlinking the
Dockerfile helps users run runtimes such as Podman.

* Add in new entrypoint files and fix the app path in docker-entrypoint.sh

* Refactor the docker-compose.yml file so it doesn't build the main
application container three times in a row. We can use the same
container for web, webpacker, and sidekiq.

Also make the volume names very explicit on what their contents and add
in SELinux context support with :Z

* Fix ELASTICSEARCH_URL.

* Remove the absolute path on ip binary and add in iproute to Containerfile.

* Symlink the Dockerfile to Containerfile and add in a container-compose.yml file
for usage with podman-compose. We are waiting for this issue to get resolved

https://github.com/containers/libpod/issues/6153

and for podman-compose to mature a bit more. A user using podman-compose can use

podman-compose -f container-compose.yml

to launch the DEV container stack with Podman.

* Update the .gitignore file to reflect the new container volumes.

* Fix the entrypoint script on the Containerfile and clean up a bunch of things.

* Rework the Containerfile to prep it to run as a non-root user. We have to wait
for this issue to get fixed:

https://github.com/containers/libpod/issues/6153

for Linux users and then we can uncomment the USER line so we are running Rails
as a non-root user. :toot:

* This reworks the compose files so each task that is needed to start the app has
a correct wait command with dockerize. It also adds in containers for doing
yarn and bundle things for development. Since we mount the code directory inside
the container we lose our pre-containerized gems and node_modules.

This means users can run:

Linux
podman-compose -f container-compose.yml up

Mac
docker-compose up

and it should correctly build the app stack with containers!

* Clean up old container related things.

* Add in some container pre-reqs and my name to the "Core team" section! :toot:

* Adjust the seed and sidekiq compose entries so they do not use the web entrypoint
and set the REDIS_URL and REDIS_SESSIONS_URL env vars for seed.

Add in some echos to the entrypoint.sh.

Also set docker-compose to use :delegated on mount points to speed things up.

https://docs.docker.com/storage/bind-mounts/#configure-mount-consistency-for-macos

* Just call yarn install --dev on the yarn container.

* Update documentation to support Docker and Podman as Container Engines and
move the page from docker to containers to reflect the fact not all users run
their containers via Docker.

There are dozens of us... DOZENS!

* Set --local on bundle config so it just impacts this Ruby app.

* Renamed bin/docker-setup to bin/container-setup to reflect the fact that that
we can use Podman as a container engine. I also refactored it so it does some
basic pre-flight checks for docker and docker-compose or podman and
podman-compose to make sure users have a container engine installed.

* Set cache_all_platforms true for bundler.

* Bump docker-compose dockerize -timeout to 45min for slower macOS hardware.

* Move to the consolidated app_initializer:setup rake task for bootstrapping the
app.

* Update docs/installation/readme.md
2020-05-28 12:11:51 -05:00
rhymes
5c17e5c25d
Upgrade Ruby to 2.7.1 (#7097) [deploy]
* Upgrade Ruby to 2.7.1

* Use explicit version in Dockerfile

* Fix docs Gemfile
2020-04-06 18:21:50 +02:00
rhymes
6bede2a92b
Upgrade to Ruby 2.7.0 (#5281) [deploy]
* Upgrade to Ruby 2.7.0

* Upgrade Travis's Ruby as well

* Fix conflict

* Silence all Ruby 2.7 deprecation warnings in dev mode

* Silence dev and test unless CI
2020-04-03 17:36:19 +02:00
Arit Amana
1310218633
Add my name to Core Team list (#6974) 2020-03-31 11:11:59 -04:00
rhymes
6f3a8bb407
Bump min version of PostgreSQL (#6443) 2020-03-04 16:40:49 +01: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
rhymes
44670e2939
Add various badges to README [skip ci] (#5931)
* Add some badges to the README

* Add proper Netlify badge

* Add Honeybadger badge
2020-02-06 19:23:18 -05:00
Fernando Valverde
e8523c0749
Adds core team member [ci skip] (#5881) 2020-02-05 16:59:21 -05:00
Ridhwana
6b53331476
chore: add a core team member (#5812) 2020-02-03 11:15:10 -05:00
Julianna Tetreault
ba139f5855
Add name to Core Team list in README (#5801) 2020-01-28 19:21:43 -05:00
Vaidehi Joshi
544bc3f9a9 Add Vaidehi to core contributors [ci-skip] (#5635) 2020-01-22 09:39:30 -05:00
Joshua Puetz
02c3d50024 Add joshpuetz to core contributors [ci-skip] (#5632) 2020-01-21 17:12:27 -05:00
Nick Taylor
c9a2fc058f Add nickytonline to core team (#5628) [ci skip] 2020-01-21 13:46:29 -05:00
Michael Kohl
b89ebd133e Add myself to core team in README (#5540) 2020-01-16 08:47:17 -05:00
Alex
e3d83896f0 Add Alex Smith to core team members [ci skip] (#5534) 2020-01-15 16:35:22 -05:00
Molly Struve
2470355e89 Implement Datadog tracing agent and APM (#5107) [deploy]
* Implement Datadog tracing agent and APM

* if I had a nickle....

* more double quoted strings and rubocop fixes

* put gems in the right order

* Remove skylight to prevent initializer collisions with Datadog which cause infinite loops

* remove skylight config files
2019-12-27 15:49:05 -05:00
Sven Efftinge
ac8865b92b Disable .ruby-version dependency on GitPod (#4979) 2019-12-02 15:07:23 -05:00
Jacob Herrington
845b07aae3 Update readme formatting (#4943)
* Update readme to adopt expected markdown wrapping

In another commit (7d0aeee), we chose to lean on Prettier for
linewrapping markdown files at 80 characters. The reasoning is explained
in that commit message, but briefly: enforcing linewrapping in
documentation files makes the git history cleaner over time, allowing
more specific git blames and more context for people working on
documentation in the future.

This commit applies that same change to the README.

* Remove duplicated documentation [ci skip]

The information regarding installation is available at docs.dev.to,
maintaining that information here is duplication and very likely to fall
out of sync (for example, the readme is currently missing the Redis
dependency) with current information.

Therefore, it's probably better to just remove this stuff and link
directly to our more complete documentation so that people aren't
misled by potentially out of date information in the readme.
2019-11-27 09:53:55 -05:00
James Vanderburg
2d373c2de3 README updates for clarification (#4584)
* Update README to clarify Algolia setup

Added a little bit to the line about Algolia environment variable setup
to clarify things for users like me who don't read ahead a little bit
and forgot how env variables work :)

* Add ImageMagick to prerequisites section
2019-10-26 13:28:54 -04:00
Paweł Świątkowski
d42f8e7cc0 Remove dead links from Table of Contents (#4557) [ci skip] 2019-10-23 10:20:10 -04:00
Molly Struve
248648d1ec Add Molly Struve to core team members (#4530) [ci skip] 2019-10-21 16:17:39 -04:00
rhymes
89476fae08 Upgrade Ruby to 2.6.5 (#4451) 2019-10-17 09:34:31 -04:00
Chris Johnston
5da6c4e1c7 Add anchor and basic setup using docker (#4187) [ci skip] 2019-10-03 11:10:15 -04:00
Jacob Herrington
57d1601caf Update core team members [ci skip] (#4150) 2019-09-30 12:43:45 -04:00
Jacob Herrington
5325557701 Add a comma and fix split infinitive (#3931)
Split infinitives are super subjective:
https://www.quickanddirtytips.com/education/grammar/split-infinitives
2019-09-03 12:48:24 -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
Jess Lee
8c10d411d3 updated contributing.md (#3659) 2019-08-08 11:53:42 -03:00
Jess Lee
67b044da19 Update content policy and faqs about sponsorship (#3634)
* add affiliate link disclosure to content policy

* point ppl to partnerships page instead of peters email

* update broken licensing link
2019-08-05 16:41:17 -04:00
Jess Lee
256629ed16 Update Readme (#3609) [ci skip] 2019-08-02 16:55:05 -04:00
Jess Lee
757e969bed Update Readme (#3598) [ci skip] 2019-08-01 11:51:56 -04:00
Nick Taylor
ef08fa8505 Add the dependabot badge. (#3268) [ci skip] 2019-06-24 12:38:48 -04:00
Mac Siri
40832602ce
Add Vulnerability disclosure to README (#3043) [ci skip] 2019-06-04 14:52:53 -04:00
briwa
b8908c5190 fix(README): link to the testing doc is broken (#3006)
[ci skip]
2019-05-30 17:36:22 -04:00
Jesse M. Holmes
d7975637c5 Fix wording in readme.md (#2932)
* Renamee "Basic Installation" to the correct "Standard Installation"
* Added link to Standard Installation
2019-05-22 09:44:08 -04:00
rhymes
c9116f6d4d Add rhymes to core team in README [ci skip] (#2875) 2019-05-18 18:47:06 -04:00
rhymes
e626002260 Add alternative texts to images (#2771) [ci skip] 2019-05-09 11:16:03 -04:00
Mohammadjavad Raadi
04758f46f8 Fixes broken link of maintain your fork guide in README.md (#2698) 2019-05-05 10:12:34 -04:00
rhymes
56e13d00f0 Upgrade Ruby to 2.6.3 (#2649) 2019-05-02 12:06:18 -04:00
Rushaine McBean
6fbfdd02f6 Updates links within repo README for setting up environment variables (#2628) 2019-04-30 14:29:37 -04:00
Desi Rottman
803771d081 remove Product Roadmap link from TOC (#2423)
it looks like the Product Roadmap section of the Read Me was removed at 65bdaa86f3 (diff-04c6e90faac2675aa89e2176d2eec7d8), so that anchor was broken. this removes the link from the Table Of Contents.
2019-04-13 13:26:24 -04:00
Jan Keromnes
6bc248e43b Automated DEV setup using Gitpod (#2321) 2019-04-07 17:08:30 -04:00
Mac Siri
7147428821 Update Rails version on README [ci skip] 2019-04-03 14:15:17 -04:00
Jess Lee
65bdaa86f3 Remove product roadmap and clarify need for design mockups (#2206) [ci skip] 2019-03-25 15:34:00 -04:00
Abraham Williams
fdd18e6bb1 Simplify development setup (#2143) 2019-03-25 12:53:39 -04:00