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.

Sign up for GitHub

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

Provide a single, unified source of documentation #1811

Merged
merged 4 commits into from
Oct 29, 2020
Merged

Provide a single, unified source of documentation #1811

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2d6542d
Provide a single, unified source of documentation
pablobm Oct 29, 2020
3b5136c
Better link
pablobm Oct 29, 2020
1fe0c0d
Hard-wrapping consistent with the rest of the file
pablobm Oct 29, 2020
23afb73
No point in separating the link
pablobm Oct 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 1 addition & 51 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,56 +46,6 @@ To accomplish these goals, Administrate follows a few guiding principles:
[Rails Admin]: https://github.com/sferik/rails_admin
[ActiveAdmin]: http://activeadmin.info/

## Getting Started

Administrate supports Rails 5.0 onwards. We support Ruby 2.4 and up.

Add Administrate to your Gemfile and re-bundle:

```ruby
gem "administrate"
```

The included installer will create dashboards for each model in your
app, complete with routes:

```bash
$ rails generate administrate:install
```

Restart your server, and visit http://localhost:3000/admin
to see your new dashboard in action.

For more detailed instructions or to make it work with Rails API-only
applications, please go through the ['Getting Started' guide][].

If your apps uses Sprockets 4, you'll need to add Administrate's assets to your `manifest.js` file. To do this, add these two lines to the file:

```
//= link administrate/application.css
//= link administrate/application.js
```

Otherwise, your app will show you this error:

```
Asset `administrate/application.css` was not declared to be precompiled in production.
Declare links to your assets in `app/assets/config/manifest.js`.
```

For more information on why this is necessary, see https://www.schneems.com/2017/11/22/self-hosted-config-introducing-the-sprockets-manifestjs

['Getting Started' guide]: https://administrate-demo.herokuapp.com/getting_started

## Create Additional Dashboards

In order to create additional dashboards, pass in the resource name to
the dashboard generator. A dashboard and controller will be created.

```bash
$ rails generate administrate:dashboard Foo
```

## Documentation

To customize the appearance, behavior, and contents of the dashboard,
Expand All @@ -114,7 +64,7 @@ app][prerelease_docs].

Please see [CONTRIBUTING.md](/CONTRIBUTING.md).

administrate was originally written by Grace Youngblood and is now maintained by
Administrate was originally written by Grace Youngblood and is now maintained by
Nick Charlton. Many improvements and bugfixes were contributed by the [open
source
community](https://github.com/thoughtbot/administrate/graphs/contributors).
Expand Down
28 changes: 24 additions & 4 deletions docs/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@ title: Getting Started
---

Administrate is released as a Ruby gem, and can be installed on Rails
applications version 4.2 or greater.
applications version 5.0 or greater. We support Ruby 2.4 and up.

Add the following to your Gemfile:
First, add the following to your Gemfile:

```ruby
# Gemfile
gem "administrate"
```

Re-bundle, then run the installer:
Re-bundle with `bundle install`, then run the installer:

```bash
$ rails generate administrate:install
Expand Down Expand Up @@ -56,6 +56,26 @@ Each `Admin::FooController` can be overwritten to specify custom behavior.
Once you have Administrate installed,
visit <http://localhost:3000/admin> to see your new dashboard in action.

### Errors about assets?

If your apps uses Sprockets 4, you'll need to add Administrate's assets to
your `manifest.js` file. To do this, add these two lines to the file:

```
//= link administrate/application.css
//= link administrate/application.js
```

Otherwise, your app will show you this error:

```
Asset `administrate/application.css` was not declared to be precompiled in production.
Declare links to your assets in `app/assets/config/manifest.js`.
```

For more information on why this is necessary, see Richard Schneeman's article
["Self Hosted Config: Introducing the Sprockets manifest.js"][https://www.schneems.com/2017/11/22/self-hosted-config-introducing-the-sprockets-manifestjs]

## Create Additional Dashboards

In order to create additional dashboards, pass in the resource name to
Expand All @@ -65,7 +85,7 @@ the dashboard generator. A dashboard and controller will be created.
$ rails generate administrate:dashboard Foo
```

Add a route for the new dashboard.
Then add a route for the new dashboard.

```ruby
# config/routes.rb
Expand Down