Skip to content
This repository has been archived by the owner on Oct 8, 2020. It is now read-only.

CRM-20600 - Add chapters for AngularJS and AssetBuilder #172

Merged
merged 17 commits into from
Jun 20, 2017

Conversation

totten
Copy link
Member

@totten totten commented Jun 3, 2017

@seancolsen
Copy link
Contributor

@totten I see that civicrm/civicrm-core#10085 has now been merged. I'd like to get this content into the Dev Guide because it looks really useful. Is there more work to do here?

mkdocs.yml Outdated
@@ -57,6 +57,13 @@ pages:
- Troubleshooting: extensions/troubleshooting.md # page-tree = DONE
- Advanced patterns: extensions/advanced.md
- Framework Reference:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I propose changing this section to the following:

  - AngularJS:
    - AngularJS: framework/angular/index.md
    - AngularJS Quick Start: framework/angular/quickstart.md
    - AngularJS File Names: framework/angular/files.md
    - AngularJS Loader: framework/angular/loader.md
    - AngularJS Modifications:  framework/angular/modify.md

Reasons:

  • Use index.md for hackable URLs (This change also requires a file rename)
  • Use more descriptive menu item labels (as described here, so that the <title> element better reflects the page content).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rebased (to address merge-conflits) and updated to use this structure.

Note: I also renamed "Modifications" to "Changesets". This matches terminology that is used in the code, and it feels a bit more precise.

about the internals of AngularJS 1.x or APIv3. You should be able to follow
the discussion if you have a beginner-level understanding of both.


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I propose removing this "Additional pages" section because it's a duplication of the listing of pages in the menu and thus is prone to falling out of sync if we add/remove/re-order these pages.

@totten totten force-pushed the master-angular branch 2 times, most recently from cc7f27b to 7c1677a Compare June 20, 2017 22:02
@totten totten changed the title (WIP) CRM-20600 - Add chapters for AngularJS and AssetBuilder CRM-20600 - Add chapters for AngularJS and AssetBuilder Jun 20, 2017
@totten
Copy link
Member Author

totten commented Jun 20, 2017

I've removed the "WIP" label. Most sections should be presentable.

I don't have a strong opinion on whether to merge now or to wait a bit. There is one page (framework/angular/changeset.md) which is incomplete and has a prominent disclaimer at the top. On the other hand, I'm not sure if that page should block the others.

@seancolsen seancolsen merged commit cdeea02 into civicrm:master Jun 20, 2017
@seancolsen
Copy link
Contributor

Exciting! This stuff looks really good. I have a couple follow-up points for which I'll create tickets.

@totten totten deleted the master-angular branch June 20, 2017 22:18
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants