Move documentation into main repository #363
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| markdown = Redcarpet::Markdown.new( | ||
| Redcarpet::Render::HTML, | ||
| :fenced_code_blocks => true, | ||
| :autolink => true, |
| @@ -0,0 +1,117 @@ | |||
| $blue: #53ADC6; | |||
There was a problem hiding this comment.
Color #53ADC6 should be written as #53adc6
|
@danbee the visual regressions are unrelated to this PR. I've written up a description of the problem, along with fixes, in #408. We should look into upgrading our Percy plan. Because the regressions aren't coming from this code, I'm okay moving forward on this. |
|
Also, because we haven't approved the Percy diffs for this PR, future diffs won't be compared against this. They'll be compared against the last commit on master that was approved. Yay! |
| $blue: #8fbdcc; | ||
| $cyan: #b95c56; | ||
| $yellow: #f8d29d; | ||
| $red: #b95c56; |
There was a problem hiding this comment.
Move these colors to the top of the file, pls. Even better, move them to variables.scss
a51aff7 to
df881ad
Compare
Problem: Documentation is being kept at https://github.com/thoughtbot/administrate-docs. It is difficult to maintain documentation when it is kept in a separate repository from the rest of the app. So far, there has only been one documentation pull request. We'd like to encourage more people to submit documentation suggestions. Solution: - Move documentation from its original source to within the main Administrate repo. - Copy over all existing styles from the documentation app.
|
@Graysonwright Apologies for not getting to look at this today. |
|
oh, no worries! I was working with Tyson a bit on CSS stuff mostly. |
c-lliope
added a commit
that referenced
this pull request
Jan 22, 2016
Changes: ``` * [#269] [FEATURE] Add a generator for copying default layout files * [#328] [FEATURE] Add a generator for copying default sidebar partial * [#362] [FEATURE] Add a generator for only the dashboard manifest. Customizing this manifest before running the `administrate:install` generator will change which dashboards get generated. * [#295] [FEATURE] Add dashboard detection for ActiveRecord::Enum fields. * [#364] [FEATURE] Improve dashboard generator by explicitly listing out the generated `SHOW_PAGE_ATTRIBUTES` array elements. * [#416] [UI] Add an accessibility label to the search input * [#411] [UI] Use tabular figures in table cells * [#409] [UI] Use default system fonts * [#424] [BUGFIX] Fix a bug where running `rails destroy GENERATOR_NAME` would not work for several of the generators * [#390] [BUGFIX] Fix timestamp deprecation warnings * [#365] [COMPAT] Remove dependency on `inline_svg` * [#396] [I18n] Ukrainian * [#297] [I18n] Italian * [#307] [I18n] Fix German grammatical errors * [#363] [DOC] Move documentation into main repository, at the root URL * [#395] [DOC] Update inline documentation for collection partial * [#387] [DOC] Fix incorrect path for generators in the docs ```
Merged
c-lliope
added a commit
that referenced
this pull request
Jan 22, 2016
Changes: ``` * [#269] [FEATURE] Add a generator for copying default layout files * [#328] [FEATURE] Add a generator for copying default sidebar partial * [#362] [FEATURE] Add a generator for only the dashboard manifest. Customizing this manifest before running the `administrate:install` generator will change which dashboards get generated. * [#295] [FEATURE] Add dashboard detection for ActiveRecord::Enum fields. * [#364] [FEATURE] Improve dashboard generator by explicitly listing out the generated `SHOW_PAGE_ATTRIBUTES` array elements. * [#416] [UI] Add an accessibility label to the search input * [#411] [UI] Use tabular figures in table cells * [#409] [UI] Use default system fonts * [#424] [BUGFIX] Fix a bug where running `rails destroy GENERATOR_NAME` would not work for several of the generators * [#390] [BUGFIX] Fix timestamp deprecation warnings * [#365] [COMPAT] Remove dependency on `inline_svg` * [#396] [I18n] Ukrainian * [#297] [I18n] Italian * [#307] [I18n] Fix German grammatical errors * [#363] [DOC] Move documentation into main repository, at the root URL * [#395] [DOC] Update inline documentation for collection partial * [#387] [DOC] Fix incorrect path for generators in the docs ```
|
Wouldn't it be good to make the docs responsive? |
|
@pmaojo - I agree, that would be great! If you'd like to take a look at that, feel free to open a new PR. This is already closed, so there's not much we can do here. |
|
@Graysonwright as I see now the documentation is in the main repo as md files, not as html. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem:
Documentation is being kept at
https://github.com/thoughtbot/administrate-docs.
It is difficult to maintain documentation when it is kept in a separate
repository from the rest of the app.
So far, there has only been one documentation pull request. We'd like to
encourage more people to submit documentation suggestions.
Solution:
to within the main Administrate repo.