Skip to content
This repository was archived by the owner on Sep 5, 2024. It is now read-only.

chore: clean up BUILD guide - #11880

Merged
Splaktar merged 1 commit into
masterfrom
cleanup-build-guide
Mar 17, 2020
Merged

chore: clean up BUILD guide#11880
Splaktar merged 1 commit into
masterfrom
cleanup-build-guide

Conversation

@Splaktar

Copy link
Copy Markdown
Contributor

PR Checklist

Please check that your PR fulfills the following requirements:

  • The commit message follows our guidelines
  • Tests for the changes have been added or this is not a bug fix / enhancement
  • Docs have been added, updated, or were not required

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Enhancement
[x] Documentation content changes
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Infrastructure changes
[ ] Other... Please describe:

What is the current behavior?

  • The BUILD.md guide is extremely out of date.
  • gulp watch-demo no longer works.

Issue Number:
Relates to #11844

What is the new behavior?

  • The BUILD.md guide is more up to date.
  • gulp watch-demo is correctly documented and working (when used with server).

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

@Splaktar Splaktar added this to the 1.1.22 milestone Mar 14, 2020
@Splaktar Splaktar self-assigned this Mar 14, 2020
@googlebot googlebot added the cla: yes PR author has signed Google's CLA: https://opensource.google.com/docs/cla/ label Mar 14, 2020
@Splaktar Splaktar added P3: important Important issues that really should be fixed when possible. type: chore labels Mar 14, 2020
@Splaktar
Splaktar requested a review from andrewseguin March 14, 2020 09:23
@Splaktar

Copy link
Copy Markdown
Contributor Author

@oliversalzburg PTAL.

@Splaktar
Splaktar force-pushed the cleanup-build-guide branch from 3742238 to 97ca60a Compare March 14, 2020 10:47
@Splaktar Splaktar added the pr: merge ready This PR is ready for a caretaker to review label Mar 14, 2020
@oliversalzburg

Copy link
Copy Markdown
Contributor

@Splaktar LGTM. There was still a mention of a server task, but I also saw you added a server.js in the tasks folder. I'm not sure if that brings back the server task, or if that was an oversight.

@Splaktar

Copy link
Copy Markdown
Contributor Author

There was still a mention of a server task, but I also saw you added a server.js in the tasks folder. I'm not sure if that brings back the server task, or if that was an oversight.

Yes, that adds the gulp server task back since our gulp site task does not serve the whole repo, which watch-demo requires since the demos it builds read libraries from node_modules/.

@Splaktar
Splaktar requested a review from mmalerba March 17, 2020 09:45

@mmalerba mmalerba left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@Splaktar
Splaktar merged commit 4093953 into master Mar 17, 2020
@Splaktar
Splaktar deleted the cleanup-build-guide branch March 17, 2020 18:34
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

cla: yes PR author has signed Google's CLA: https://opensource.google.com/docs/cla/ P3: important Important issues that really should be fixed when possible. pr: merge ready This PR is ready for a caretaker to review type: chore

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants