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.

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

Add boilerplate info about how to get support and provide feedback. #680

Merged
merged 91 commits into from
Jan 18, 2019

Conversation

kbrandl
Copy link
Contributor

@kbrandl kbrandl commented Jan 17, 2019

Also, disable the OPS "feedback" feature.

Note: this PR adds boilerplate to all files except for files in the /api folder (a separate PR will update those files).

Kim Brandl and others added 30 commits January 14, 2019 12:51
…e to reference that article; turn off the feedback feature for the doc set.
1. Removed bold formatting on table heading, which interferes with the OPS heading style (the OPS style is a darker black that is different from the bold black).
2. Updated VBA-Docs (from lowercase "docs") to reflect actual repo name
3. Removed en-us from links so they go to localized pages (if any)
4. Added breaks where necessary to improve readability
@opbld32
Copy link

opbld32 commented Jan 17, 2019

OPS Build status updates of commit a974700:

🕙 Preparing: average preparing time is 3 min(s) 15 sec(s)

@kbrandl kbrandl requested a review from Linda-Editor January 17, 2019 23:02
@opbld33
Copy link

opbld33 commented Jan 17, 2019

OPS Build status updates of commit a974700:

🕙 Full build: average full build time is not available, there is no data for this repository.

Note: A full build takes more time than an incremental build. This is the expected behavior of the build system.

@kbrandl
Copy link
Contributor Author

kbrandl commented Jan 17, 2019

@Linda-Editor here's the PR that adds the new boilerplate support/feedback content at the bottom of every file (and disables the OPS "feedback" feature). I've requested your review so that you can spot-check these changes. To do so, I'd suggest you take a look at the changes in several of the commits that this PR contains (for example: fed1c6e).

image

The only type of change that you should see in each file is adding the [!include[Support and feedback](~/includes/feedback-boilerplate.md)] statement at the end of the file (sometimes extra blank lines are also added or removed near this statement -- but that's expected).

Please do not merge this PR to master until you hear from me later today. I'm waiting for the OPS build to finish so that I can verify that everything looks okay on the staging site.

@Linda-Editor
Copy link
Contributor

@kbrandl Thanks, Kim, but where did you want me to check it? I can't access staging with my current perms (for 6 months I'm off corp-net). So the only place I can see these is in the GitHub UI, I think. Or I suppose I can clone GitHub and view your branch that way (in Visual Studio Code). Would that work?

@Linda-Editor
Copy link
Contributor

@kbrandl I looked at the GitHub change file that you linked to above, and everything looks good on that.

@kbrandl
Copy link
Contributor Author

kbrandl commented Jan 17, 2019

@Linda-Editor you should use the GitHub UI to spot check the changes.

  1. Within this PR, click the Commits tab:
    image

  2. From the Commits page, click the link for any of today's commits:

    image

  3. Within each commit, the only type of change that you should see in each file is adding the [!include[Support and feedback](~/includes/feedback-boilerplate.md)] statement at the end of the file (sometimes extra blank lines are also added or removed near this statement -- but that's expected).

Check several commits, and if you see any types of changes other than the new [!include[Support and feedback](~/includes/feedback-boilerplate.md)] statement (and blank lines added or removed) at the end of the file, let me know by commenting here. (There are 90 commits -- you don't need to review them all -- just randomly pick 10-15 to check.)

@Linda-Editor
Copy link
Contributor

@kbrandl Okay, will do.

@Linda-Editor
Copy link
Contributor

@kbrandl I randomly selected about 10 sets and scanned them, and all look good...

@kbrandl
Copy link
Contributor Author

kbrandl commented Jan 17, 2019

@Linda-Editor thank you for reviewing -- can you please mark this PR as "Approved"? I will merge it to master after I'm able to verify changes on the staging site later today (build has been running for 2+ hours).

BTW -- I see that Linda Lu has merged other PRs to master within the last hour. Can you please tell her to stop working in this repo (and to not 'publish to live' today)? Thanks.

@Linda-Editor
Copy link
Contributor

@kbrandl I let Linda Lu know as soon as I saw that she did that, and she reverted the one PR she merged.

@opbld34
Copy link

opbld34 commented Jan 18, 2019

OPS Build status updates of commit a974700:

❌ Validation status: errors

File Status Preview URL Details
api/TOC.md ❌Error Details

api/TOC.md

  • [Error] W:\tuio-s\api\TOC.md is not a valid TOC File: Invalid toc file: W:\tuio-s\api\TOC.md, Details: Unknown syntax at line 37743:
    [!includeSupport and feedback]
  • [Error] Unable to load file 'api/TOC.md' via processor 'TocDocumentProcessor': W:\tuio-s\api\TOC.md is not a valid TOC File: Invalid toc file: W:\tuio-s\api\TOC.md, Details: Unknown syntax at line 37743:
    [!includeSupport and feedback]
  • [Error] W:\tuio-s\api\TOC.md is not a valid TOC File: Invalid toc file: W:\tuio-s\api\TOC.md, Details: Unknown syntax at line 37743:
    [!includeSupport and feedback]
  • [Error] Unable to load file 'api/TOC.md' via processor 'ExperimentalTocDocumentProcessor': W:\tuio-s\api\TOC.md is not a valid TOC File: Invalid toc file: W:\tuio-s\api\TOC.md, Details: Unknown syntax at line 37743:
    [!includeSupport and feedback]

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

@opbld30
Copy link

opbld30 commented Jan 18, 2019

OPS Build status updates of commit 4437511:

🕙 Preparing: average preparing time is 3 min(s) 15 sec(s)

@opbld31
Copy link

opbld31 commented Jan 18, 2019

OPS Build status updates of commit 4437511:

🕙 Full build: average full build time is not available, there is no data for this repository.

Note: A full build takes more time than an incremental build. This is the expected behavior of the build system.

@opbld33
Copy link

opbld33 commented Jan 18, 2019

OPS Build status updates of commit 4437511:

🕙 Preparing: average preparing time is 3 min(s) 15 sec(s)

@opbld34
Copy link

opbld34 commented Jan 18, 2019

OPS Build status updates of commit 4437511:

🕙 Full build: average full build time is 292 min(s) 3 sec(s) [calculated from last 1 build(s)]

Note: A full build takes more time than an incremental build. This is the expected behavior of the build system.

@opbld31
Copy link

opbld31 commented Jan 18, 2019

OPS Build status updates of commit 4437511:

✅ Validation status: passed

File Status Preview URL Details
F1/accelitems-collection-visio-vis_sdr-chm10015.md ✅Succeeded View
F1/acceltables-object-visio-vis_sdr-chm10025.md ✅Succeeded View
F1/accessconnection-property-access-vbaac10-chm12726.md ✅Succeeded View
F1/acnavigationspan-enumeration-access-vbaac10-chm14675.md ✅Succeeded View
F1/activate-event-project-vbapj-chm131127.md ✅Succeeded View
F1/activate-event-project-vbapj-chm131130.md ✅Succeeded View
F1/activate-method-project-vbapj-chm131189.md ✅Succeeded View
F1/activate-method-project-vbapj-chm131192.md ✅Succeeded View
F1/activepane-property-project-vbapj-chm131369.md ✅Succeeded View
F1/activeprofile-property-project-vbapj-chm132516.md ✅Succeeded View
F1/activewindow-property-project-vbapj-chm131372.md ✅Succeeded View
F1/activewindow-property-project-vbapj-chm131379.md ✅Succeeded View
F1/actualcost-property-project-vbapj-chm131373.md ✅Succeeded View
F1/actualduration-property-project-vbapj-chm131374.md ✅Succeeded View
F1/actualfinish-property-project-vbapj-chm131375.md ✅Succeeded View
F1/actualfinish-property-project-vbapj-chm131382.md ✅Succeeded View
F1/actualovertimecost-property-project-vbapj-chm131376.md ✅Succeeded View
F1/actualovertimecost-property-project-vbapj-chm131383.md ✅Succeeded View
F1/actualovertimework-property-project-vbapj-chm131377.md ✅Succeeded View
F1/actualstart-property-project-vbapj-chm131380.md ✅Succeeded View
F1/actualstartdrivers-object-project-vbapj-chm131336.md ✅Succeeded View
F1/actualwork-property-project-vbapj-chm131381.md ✅Succeeded View
F1/actualwork-property-project-vbapj-chm131388.md ✅Succeeded View
F1/acwp-property-project-vbapj-chm131363.md ✅Succeeded View
F1/acwp-property-project-vbapj-chm131370.md ✅Succeeded View
F1/add-method-project-vbapj-chm131191.md ✅Succeeded View
F1/add-method-project-vbapj-chm131194.md ✅Succeeded View
F1/add-method-project-vbapj-chm131390.md ✅Succeeded View
F1/add-method-project-vbapj-chm131640.md ✅Succeeded View
F1/add-method-project-vbapj-chm132273.md ✅Succeeded View
F1/add-method-project-vbapj-chm132274.md ✅Succeeded View
F1/add-method-project-vbapj-chm132297.md ✅Succeeded View
F1/add-method-project-vbapj-chm132307.md ✅Succeeded View
F1/add-method-project-vbapj-chm132330.md ✅Succeeded View
F1/add-method-project-vbapj-chm132480.md ✅Succeeded View
F1/add-method-project-vbapj-chm132517.md ✅Succeeded View
F1/add-method-project-vbapj-chm132756.md ✅Succeeded View
F1/add-method-word-vbawd10-chm159842405.md ✅Succeeded View
F1/addchart2-method-powerpoint-vbapp10-chm543036.md ✅Succeeded View
F1/addchild-method-project-vbapj-chm132353.md ✅Succeeded View
F1/addcolon-property-access-vbaac10-chm10483.md ✅Succeeded View
F1/addex-method-project-vbapj-chm132275.md ✅Succeeded View
F1/addins-object-word-vbawd10-chm2431.md ✅Succeeded View
F1/addons-object-visio-vis_sdr-chm10035.md ✅Succeeded View
F1/addsharedimage-method-access-vbaac10-chm14660.md ✅Succeeded View
F1/adjustments-object-word-vbawd10-chm2500.md ✅Succeeded View
F1/adoconnection-property-excel-vbaxl10-chm922076.md ✅Succeeded View
F1/aftercubebuilt-event-project-vbapj-chm131128.md ✅Succeeded View
F1/aftercubebuilt-event-project-vbapj-chm131131.md ✅Succeeded View
F1/aftermodal-event-visio-vis_sdr-chm10019000.md ✅Succeeded View

This comment lists only the first 50 files in the pull request.
For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

@kbrandl kbrandl merged commit c64a054 into master Jan 18, 2019
@kbrandl kbrandl deleted the kibrandl-bulk-add-feedback-boilerplate branch January 18, 2019 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants