Skip to content
This repository has been archived by the owner on Nov 16, 2023. It is now read-only.

Prepare standalone docs for publication #804

Merged
merged 15 commits into from May 1, 2020
Merged

Conversation

cgranade
Copy link
Contributor

@cgranade cgranade commented May 1, 2020

Marked as draft until #803 completes.

@acrolinxatmsft1
Copy link
Collaborator

Acrolinx Scorecards

A minimum Acrolinx score of 80 is required.

Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology.

Article Acrolinx
score
Lowest
category
score
Spelling
issues
Scorecard Processed
articles/TOC.yml 100 100 0 link
articles/install-guide/csinstall.md 98 91 0 link
articles/install-guide/index.md 88 62 0 link
articles/install-guide/pyinstall.md 94 76 0 link
articles/install-guide/standalone.md 88 75 0 link
articles/install-guide/toc.yml 87 26 0 link
articles/quickstarts/qrng.md 85 72 2 link
articles/quickstarts/search.md 81 58 1 link
articles/relnotes/index.md 75 41 21 link

More information about Acrolinx

@opbld31
Copy link

opbld31 commented May 1, 2020

Docs Build status updates of commit 4d85dd6:

✅ Validation status: passed

File Status Preview URL Details
.openpublishing.publish.config.json ✅Succeeded
.vscode/settings.json ✅Succeeded
articles/TOC.yml ✅Succeeded View
articles/install-guide/csinstall.md ✅Succeeded View
articles/install-guide/index.md ✅Succeeded View
articles/install-guide/pyinstall.md ✅Succeeded View
articles/install-guide/standalone.md ✅Succeeded View
articles/install-guide/toc.yml ✅Succeeded
articles/quickstarts/qrng.md ✅Succeeded View
articles/quickstarts/search.md ✅Succeeded View
articles/relnotes/index.md ✅Succeeded View

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.

@geduardo
Copy link
Contributor

geduardo commented May 1, 2020

We should also update the articles/install-guide/index.md file to reflect the new installation guide structure.

@acrolinxatmsft1
Copy link
Collaborator

Acrolinx Scorecards

A minimum Acrolinx score of 80 is required.

Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology.

Article Acrolinx
score
Lowest
category
score
Spelling
issues
Scorecard Processed
articles/TOC.yml 100 100 0 link
articles/install-guide/csinstall.md 98 91 0 link
articles/install-guide/index.md 88 62 0 link
articles/install-guide/pyinstall.md 94 76 0 link
articles/install-guide/standalone.md 88 75 0 link
articles/install-guide/toc.yml 87 26 0 link
articles/quickstarts/qrng.md 85 72 2 link
articles/quickstarts/search.md 81 58 1 link
articles/relnotes/index.md 75 41 21 link

More information about Acrolinx

@opbld34
Copy link

opbld34 commented May 1, 2020

Docs Build status updates of commit 0d0d8b7:

✅ Validation status: passed

File Status Preview URL Details
.github/workflows/check-samples-branch.yml ✅Succeeded
.vscode/settings.json ✅Succeeded
articles/TOC.yml ✅Succeeded View
articles/install-guide/csinstall.md ✅Succeeded View
articles/install-guide/index.md ✅Succeeded View
articles/install-guide/pyinstall.md ✅Succeeded View
articles/install-guide/standalone.md ✅Succeeded View
articles/install-guide/toc.yml ✅Succeeded
articles/quickstarts/qrng.md ✅Succeeded View
articles/quickstarts/search.md ✅Succeeded View
articles/relnotes/index.md ✅Succeeded View

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.

@cgranade cgranade marked this pull request as ready for review May 1, 2020 18:41
Comment on lines 28 to 30
<!---
- [Install Q# for C#:](xref:microsoft.quantum.install.cs) choose this environment if you want to combine C# and Q# to create a C# host program that calls Q# operations.
-->
Copy link
Contributor

@geduardo geduardo May 1, 2020

Choose a reason for hiding this comment

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

Suggested change
<!---
- [Install Q# for C#:](xref:microsoft.quantum.install.cs) choose this environment if you want to combine C# and Q# to create a C# host program that calls Q# operations.
-->
- [Install Q# for .NET:](xref:microsoft.quantum.install.cs) Q# can also be combined with the .NET ecosystem. Choose this environment if you want to combine F# or C# with Q# to create classical host programs that call Q# operations.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Please see #806.

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change

        <!---
      
      
        
        - [Install Q# for C#:](xref:microsoft.quantum.install.cs) choose this environment if you want to combine C# and Q# to create a C# host program that calls Q# operations.
      
      
        
        -->
      
      
        
        - [Install Q# for .NET:](xref:microsoft.quantum.install.cs) Q# can also be combined with the .NET ecosystem. Choose this environment if you want to combine F# or C# with Q# to create classical host programs that call Q# operations.

Thank you, I was looking for this.

@cgranade
Copy link
Contributor Author

cgranade commented May 1, 2020

We should also update the articles/install-guide/index.md file to reflect the new installation guide structure.

Sounds good. Since feature branches are protected, that will need a separate PR either before this that targets feature/standalone, or after this and that targets master.

@acrolinxatmsft1
Copy link
Collaborator

Acrolinx Scorecards

A minimum Acrolinx score of 80 is required.

Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology.

Article Acrolinx
score
Lowest
category
score
Spelling
issues
Scorecard Processed
articles/TOC.yml 100 100 0 link
articles/install-guide/csinstall.md 98 91 0 link
articles/install-guide/index.md 90 65 0 link
articles/install-guide/pyinstall.md 94 76 0 link
articles/install-guide/standalone.md 88 75 0 link
articles/install-guide/toc.yml 87 26 0 link
articles/quickstarts/qrng.md 85 72 2 link
articles/quickstarts/search.md 81 58 1 link
articles/relnotes/index.md 75 41 21 link

More information about Acrolinx

@opbld34
Copy link

opbld34 commented May 1, 2020

Docs Build status updates of commit 2765b6c:

✅ Validation status: passed

File Status Preview URL Details
.github/workflows/check-samples-branch.yml ✅Succeeded
.vscode/settings.json ✅Succeeded
articles/TOC.yml ✅Succeeded View
articles/install-guide/csinstall.md ✅Succeeded View
articles/install-guide/index.md ✅Succeeded View
articles/install-guide/pyinstall.md ✅Succeeded View
articles/install-guide/standalone.md ✅Succeeded View
articles/install-guide/toc.yml ✅Succeeded
articles/quickstarts/qrng.md ✅Succeeded View
articles/quickstarts/search.md ✅Succeeded View
articles/relnotes/index.md ✅Succeeded View

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.

@cgranade cgranade merged commit 6ed1b5b into master May 1, 2020
@cgranade cgranade deleted the feature/standalone branch May 1, 2020 18:57
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.

None yet

8 participants