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

Document both demo apps consistently #1813

Merged
merged 1 commit into from
Oct 29, 2020
Merged

Document both demo apps consistently #1813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 4 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,8 @@ This will start the application defined in `spec/example_app`.

* The gem's source code lives in the `app` and `lib` subdirectories.
* The demo app is nested within `spec/example_app`.
* The guides as seen at
[https://administrate-demo.herokuapp.com][docs] live as
Markdown files in the `docs` subdirectory.
* The guides as seen at [https://administrate-demo.herokuapp.com][docs] live
as Markdown files in the `docs` subdirectory.

Rails configuration files have been changed
to recognize the app in the new location,
Expand All @@ -63,8 +62,7 @@ With this structure, developing a typical feature looks like:
* Implement a feature in `administrate/`
* Exercise the feature using the demo rails app (`spec/example_app/app/`)

[demo]: https://administrate-prototype.herokuapp.com/admin
[docs]: https://administrate-prototype.herokuapp.com
[docs]: https://administrate-demo.herokuapp.com

## Front-end Architecture

Expand Down Expand Up @@ -125,7 +123,7 @@ there's significant enough changes.
A new release involves cutting and pushing a new version to [Ruby Gems][] and
then deploying that version of the example application and documentation. This
means that [the demo application][demo] always matches the current release,
whilst [the pre-release application][pre-release] can track current `master`.
whilst [the pre-release application][pre-release] will track current `master`.

[Ruby Gems]: https://rubygems.org/gems/administrate
[demo]: https://administrate-demo.herokuapp.com/
Expand Down
19 changes: 14 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ home: true
A framework for creating flexible, powerful admin dashboards in Rails.
[Try the demo][demo].

[demo]: https://administrate-demo.herokuapp.com/admin

### Warning:

Administrate is still pre-1.0,
Expand Down Expand Up @@ -64,7 +66,8 @@ $ 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](https://administrate-prototype.herokuapp.com/getting_started).
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:

Expand All @@ -82,6 +85,8 @@ 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
Expand All @@ -94,11 +99,17 @@ $ rails generate administrate:dashboard Foo
## Documentation

To customize the appearance, behavior, and contents of the dashboard,
see the guides at
[https://administrate-prototype.herokuapp.com][prototype_heroku].
we publish a set [of guides for the current release][released_docs].

These guides are available as markdown files in the `docs` subdirectory of the
git repository, too.

We publish [docs for the upcoming release, which you can find at our prerelease
app][prerelease_docs].

[released_docs]: https://administrate-demo.herokuapp.com/docs
[prerelease_docs]: https://administrate-demo-prerelease.herokuapp.com/docs

## Contributing

Please see [CONTRIBUTING.md](/CONTRIBUTING.md).
Expand All @@ -125,7 +136,5 @@ We love open source software!
See [our other projects][community] or
[hire us][hire] to design, develop, and grow your product.

[demo]: https://administrate-prototype.herokuapp.com/admin
[prototype_heroku]: https://administrate-prototype.herokuapp.com
[community]: https://thoughtbot.com/community?utm_source=github
[hire]: https://thoughtbot.com?utm_source=github
2 changes: 1 addition & 1 deletion administrate.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Gem::Specification.new do |s|
s.version = Administrate::VERSION
s.authors = ["Nick Charlton", "Grayson Wright"]
s.email = ["[email protected]", "[email protected]"]
s.homepage = "https://administrate-prototype.herokuapp.com/"
s.homepage = "https://administrate-demo.herokuapp.com/"
s.summary = "A Rails engine for creating super-flexible admin dashboards"
s.license = "MIT"

Expand Down