Skip to content

Commit

Permalink
Merge pull request #3436 from nebulab/kennyadsl/guide-updates
Browse files Browse the repository at this point in the history
Updates Guides: Security and simple installation
  • Loading branch information
kennyadsl authored Dec 2, 2019
2 parents 3f2223b + 52b4264 commit 6aa7436
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 12 deletions.
1 change: 0 additions & 1 deletion guides/source/assets/stylesheets/components/_blocks.scss
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@

a {
opacity: 0.8;
display: inline-block;
}

ul li, ol li { margin: .25rem 0; }
Expand Down
2 changes: 1 addition & 1 deletion guides/source/assets/stylesheets/components/_layout.scss
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ body{

//Site header
.site-header{
background-image: linear-gradient(to top, #716ff9, #3c76f0);
background: #3c76f0;
transition: transform .3s ease-in-out;

@include media-breakpoint-down(md){
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@
@include media-breakpoint-up(xl){ padding-right: 50px; }

.navbar-header{
background-image: linear-gradient(to top, #716ff9, #3c76f0);
background: #3c76f0;
padding: 20px 25px;
margin: 0 0 27px;
overflow: hidden;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# First-time installation

This article will help you install and run Solidus on your local machine for the
first time. This guide is aimed specifically at developers running macOS.
first time. This guide is aimed specifically at developers running macOS.

If you run Linux or Windows, or you don't use [Homebrew][brew] on your Mac, you
can still follow this guide. However, you may want to consult other
Expand All @@ -20,7 +20,7 @@ If you are still not able to get Solidus running, [open an issue on
GitHub][solidus-github-issue] with any information you think would help us
reproduce the issues you're having. That would include your operating system and
its version, the versions of Ruby, Rails, and SQLite 3 that you are running, and
the specific error messages you are receiving during installation.
the specific error messages you are receiving during installation.

[solidus-github-issue]: https://github.com/solidusio/solidus/issues/new
[slack-invitation]: http://slack.solidus.io
Expand Down Expand Up @@ -63,14 +63,14 @@ Homebrew][ruby-homebrew] if you need to upgrade from your system's Ruby.
Using Homebrew, you can install all of the requirements using the following
commands:

```bash
```bash
brew install ruby sqlite3 imagemagick
gem install rails
```

See more detailed installation information below.

### Upgrade Ruby on macOS
### Upgrade Ruby on macOS

If you run macOS Sierra or an older OS, you system's version of Ruby will need
to be upgraded from 2.0.x to 2.2.2 or newer. You can check what version of Ruby
Expand Down Expand Up @@ -129,7 +129,7 @@ This will install Rails as well as its dependencies.
ImageMagick helps you create, edit, and save to hundreds of image file formats.
It is required by [Paperclip](https://github.com/thoughtbot/paperclip),
which Solidus currently uses to handle file attachments. To install ImageMagick
via Homebrew, use the command:
via Homebrew, use the command:

```bash
brew install imagemagick
Expand All @@ -148,14 +148,18 @@ Solidus.
First, we need a new Rails project:

```bash
rails new your_solidus_project_name
rails new your_solidus_project_name --skip_webpack_install
```

This command will create a new Rails application without installing
[webpacker][webpacker], which is not required for a sample Solidus store. You
are free to install and configure webpacker in your Solidus store though.

Once the new project has finished being created, we can open the project's newly
created `Gemfile` in a text editor and add the required Solidus gems as new
lines:

```ruby
```ruby
gem 'solidus'
gem 'solidus_auth_devise'
```
Expand Down Expand Up @@ -192,6 +196,7 @@ bundle install
[solidus-backend]: https://github.com/solidusio/solidus/tree/master/backend
[solidus-sample]: https://github.com/solidusio/solidus/tree/master/sample
[solidus-gem-documentation]: http://docs.solidus.io
[webpacker]: https://github.com/rails/webpacker/

### Start generating Solidus configuration files

Expand Down
24 changes: 22 additions & 2 deletions guides/source/partials/_security_updates.erb
Original file line number Diff line number Diff line change
@@ -1,6 +1,26 @@
<div class="content-block bg-danger">
<h2 class="title">Security updates</h2>
<p>While we will post all security vulnerabilities here and on the <a href="https://solidus.io/blog/" target="_blank">Solidus blog<%= inline_svg("icons/external-link.svg", class: "isvg") %></a> you may wish to recieve notifications. For instant updates you can subscribe to the
<a href="https://groups.google.com/forum/#!forum/solidus-security" target="_blank">Google group<%= inline_svg("icons/external-link.svg", class: "isvg") %></a>.
<p>
The best way to receive all the security announcements is to
<a href="https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies" target="_blank">
enable alerts for vulnerable dependencies in GitHub
<%= inline_svg("icons/external-link.svg", class: "isvg") %>
</a>
or to subscribe to the
<a href="https://groups.google.com/forum/#!forum/solidus-security" target="_blank">
Solidus Security mailing list
<%= inline_svg("icons/external-link.svg", class: "isvg") %>
</a>.

The mailing list is very low traffic, and it receives the public
notifications the moment the vulnerability is published.
</p>

<p>
You can find more information on our official
<a href="https://solidus.io/security/" target="_blank">
security policy page
<%= inline_svg("icons/external-link.svg", class: "isvg") %>
</a>.
</p>
</div>

0 comments on commit 6aa7436

Please sign in to comment.