Thanks to @codeman7 for his help getting me started on #6151. I found this hard enough to do on my own that I thought others might have trouble too. I realize there are many questions of taste that go into this sort of documentation:
- Does it belong here, or somewhere else?
- Are any of the steps too detailed, or not detailed enough?
- Does it start too early? In other words, would anybody who's reading this actually need the first few steps?
- Should I mention how to work around #5825 as a Known Issue, or should I assume that will get fixed soon enough that it isn't worth mentioning?
I'm assuming I don't have this written *exactly* the way you'd like it, so this PR is intended to start a discussion.
This fixes the website generator.
9f222f9a330a3fa39a7c91faef814d4de8966b0f removed the hotfixing.md file but did not update links to that file. Our website generator ensures links within our repo do not 404. I did not look at the presubmit results when I merged that PR, forgetting the fact that our website generator validates links.
* [Docs] Adds platform configuration for the doc site.
* [Docs] Adds path metadata for documentation site.
This field is used to determine where the file will appear in the
doc site.
* [Docs] Updates Material guideline links to latest URL.
material.google.com -> material.io/guidelines
* [Docs] Introduces a separate component index for the docsite.
* [Docs] Changes the directory used for site generation.
* [Docs] Moves documentation-site-only Markdown into its own directory.
* [Docs] Changes material.io links to use https.
* [Docs] Renames the howto and contributing docsite sections to docs.
* [Docs] Adds a navTitle field to the collection editing/styling pages.
* [Docs] Changes the FAQ heading to be one size bigger.
* [Docs] Changes the tutorial title.
* [Docs] Adds icons to three more components.
* [Docs] Introduces a root component directory called /catalog/.
* [Docs] Adds an icon to the AnimationTiming component.
* [Docs] Adds an icon for the typography component.
* [Docs] Reformats the docsite index.
There are more changes to come, but it's time we merged back.
Changes:
* Re-introduces the doc site scripts and files that had been deleted previously.
* Updates contributing docs to reflect doc structure changes.
* Applies common header structure across all component documentation.
* Fixes a bunch of liquid syntax bugs.
* Inlines Front Matter metadata in README.md files as HTML comments. Any file prefixed with
<!--docs:
...yaml
-->
Will be converted into Front Matter when generating the site.
* .jekyll_prefix files, which previously stored the data, have been removed.
Summary: Created separate README.md and README.yaml files to remove the odd display of the md in GitHub.
Reviewers: O1 Material components iOS, ajsecord
Reviewed By: O1 Material components iOS, ajsecord
Tags: #material_components_ios
Differential Revision: http://codereview.cc/D1496
We can credit any contributor who would like to be credited this way, by adding them on request to the AUTHORS file. The copyright statement changes are required for this to work. Note that this has...
Summary:
We can credit any contributor who would like to be credited this way, by adding them on request to the AUTHORS file. The copyright statement changes are required for this to work. Note that this has no legal change, since the contributors always retained their copyright despite the copyright notice, but it's a nice acknowledgement.
Changed copyright statement to include non-Google authors.
Command run:
find * \( -name '*\.m' -or -name '*\.h' -or -name '*\.swift' \) -and -not \( -path 'scripts/external*' -name Pods \) -print0 | xargs -0 sed -i '' 's/Copyright \(.*\) Google Inc/Copyright \1 the Material Components for iOS authors/'
Added non-source files.
Command run:
grep -Rl 'Copyright .* Google Inc' * --exclude-dir scripts/external --null | xargs -0 sed -i '' 's/Copyright \(.*\) Google Inc/Copyright \1 the Material Components for iOS authors/'
Reviewers: featherless, O1 Material components iOS, randallli
Reviewed By: O1 Material components iOS, randallli
Tags: #material_components_ios
Differential Revision: http://codereview.cc/D1415
Summary:
Moved appropriate sections of contributing/README.md into code-conventions.md.
Added link from README.md to code-conventions.md.
Reviewers: O1 Material components iOS, randallli
Reviewed By: O1 Material components iOS, randallli
Tags: #material_components_ios
Differential Revision: http://codereview.cc/D1405
Summary:
Added a link to the new location of the bigger contributing doc.
depends on http://codereview.cc/D1329
Reviewers: ajsecord, O1 Material components iOS
Reviewed By: ajsecord, O1 Material components iOS
Tags: #material_components_ios
Differential Revision: http://codereview.cc/D1331
Summary: "Material design" is not capitalized except when referring to the actual Material Design team at Google.
Reviewers: O1 Material components iOS, randallli
Reviewed By: O1 Material components iOS, randallli
Subscribers: randallli, featherless
Tags: #material_components_ios
Differential Revision: http://codereview.cc/D1306
Summary:
Changed "Community" text to "Contributing".
Moved community/* to contributing/* to match top-level nav changes.
Updated references everywhere. Requires matching changes to site-source that will be pushed once this is submitted.
https://github.com/google/material-components-ios/issues/315
Reviewers: #mdc_ios_owners, randallli
Reviewed By: #mdc_ios_owners, randallli
Subscribers: featherless
Projects: #material_components_ios
Differential Revision: http://codereview.cc/D598
