From cb21d911519e151c729d4335a293f3ce7a9e926f Mon Sep 17 00:00:00 2001 From: Clement Wang <47586720+wangchao1230@users.noreply.github.com> Date: Tue, 5 Sep 2023 08:32:49 +0800 Subject: [PATCH] [document] refine doc rule after repo public (#299) # Description Please add an informative description that covers that changes made by the pull request and link all relevant issues. # All Promptflow Contribution checklist: - [ ] **The pull request does not introduce [breaking changes]** - [ ] **CHANGELOG is updated for new features, bug fixes or other significant changes.** - [ ] **I have read the [contribution guidelines](../CONTRIBUTING.md).** ## General Guidelines and Best Practices - [ ] Title of the pull request is clear and informative. - [ ] There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, [see this page](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/cleaning-up-commits.md). ### Testing Guidelines - [ ] Pull request includes test coverage for the included changes. --- README.md | 2 +- docs/README.md | 2 +- docs/cloud/azureai/deploy-to-azure-appservice.md | 4 ++-- docs/how-to-guides/deploy-a-flow/deploy-using-dev-server.md | 2 +- docs/how-to-guides/deploy-a-flow/deploy-using-docker.md | 2 +- docs/tutorials/index.md | 2 +- examples/README.md | 2 +- examples/tutorials/flow-deploy/azure-app-service/README.md | 4 ++-- examples/tutorials/flow-deploy/azure-app-service/deploy.ps1 | 2 +- examples/tutorials/flow-deploy/azure-app-service/deploy.sh | 2 +- scripts/docs/conf.py | 3 --- .../readme/ghactions_driver/readme_templates/README.md.jinja2 | 2 +- src/promptflow/README.md | 2 +- src/promptflow/promptflow/_sdk/data/docker/deploy.ps1.jinja2 | 2 +- src/promptflow/promptflow/_sdk/data/docker/deploy.sh.jinja2 | 2 +- .../tests/test_configs/flows/export/linux/deploy.ps1 | 2 +- .../tests/test_configs/flows/export/linux/deploy.sh | 2 +- 17 files changed, 18 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 1d63c69e470..5ac002d5795 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ With prompt flow, you will be able to: ## Get Started with Prompt flow ⚡ -Develop your LLM apps with Prompt flow: please start with our [docs](https://microsoft.github.io/promptflow) & [examples](./examples/README.md): +Develop your LLM apps with Prompt flow: please start with our [docs](https://microsoft.github.io/promptflow/) & [examples](./examples/README.md): - [Getting Started with Prompt Flow](https://microsoft.github.io/promptflow/how-to-guides/quick-start.html): A step by step guidance to invoke your first flow run. - [Tutorial: Chat with PDF](https://github.com/microsoft/promptflow/blob/main/examples/tutorials/e2e-development/chat-with-pdf.md): An end-to-end tutorial on how to build a high quality chat application with prompt flow, including flow development and evaluation with metrics. diff --git a/docs/README.md b/docs/README.md index 699faf9f5bf..cc5cc1dcd23 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # Promptflow documentation contribute guidelines -This folder contains the source code for [prompt flow documentation site](https://microsoft.github.io/promptflow). +This folder contains the source code for [prompt flow documentation site](https://microsoft.github.io/promptflow/). This readme file will not be included in above doc site. It keeps a guide for promptflow documentation contributors. diff --git a/docs/cloud/azureai/deploy-to-azure-appservice.md b/docs/cloud/azureai/deploy-to-azure-appservice.md index 42c84965fc7..03504f2b663 100644 --- a/docs/cloud/azureai/deploy-to-azure-appservice.md +++ b/docs/cloud/azureai/deploy-to-azure-appservice.md @@ -44,11 +44,11 @@ Note that the `name` will produce a unique FQDN as AppName.azurewebsites.net. ## View and test the web app -The web app can be found via [azure portal](https://ms.portal.azure.com/) +The web app can be found via [azure portal](https://portal.azure.com/) ![img](../../media/cloud/azureml/deploy_appservice_azure_portal_img.png) -After the app created, you will need to go to https://ms.portal.azure.com/ find the app and set up the environment variables +After the app created, you will need to go to https://portal.azure.com/ find the app and set up the environment variables at (Settings>Configuration) or (Settings>Environment variables), then restart the app. ![img](../../media/cloud/azureml/deploy_appservice_set_env_var.png) diff --git a/docs/how-to-guides/deploy-a-flow/deploy-using-dev-server.md b/docs/how-to-guides/deploy-a-flow/deploy-using-dev-server.md index 961de239ed8..98c7661e4f4 100644 --- a/docs/how-to-guides/deploy-a-flow/deploy-using-dev-server.md +++ b/docs/how-to-guides/deploy-a-flow/deploy-using-dev-server.md @@ -12,7 +12,7 @@ We are going to use the [web-classification](https://github.com/microsoft/prompt an example to show how to deploy a flow. Please ensure you have [create the connection](../manage-connections.md#create-a-connection) required by flow, if not, you could -refer to [Setup connection for web-classifiction](https://github.com/microsoft/promptflow/tree/main/examples/flows/standard/web-classification#1-setup-connection). +refer to [Setup connection for web-classifiction](https://github.com/microsoft/promptflow/tree/main/examples/flows/standard/web-classification). The following CLI commands allows you serve a flow folder as an endpoint. By running this command, a [flask](https://flask.palletsprojects.com/en/) app will start in the environment where command is executed, please ensure all prerequisites required by flow have been installed. diff --git a/docs/how-to-guides/deploy-a-flow/deploy-using-docker.md b/docs/how-to-guides/deploy-a-flow/deploy-using-docker.md index 21188f6b3a4..164496b0576 100644 --- a/docs/how-to-guides/deploy-a-flow/deploy-using-docker.md +++ b/docs/how-to-guides/deploy-a-flow/deploy-using-docker.md @@ -46,7 +46,7 @@ We are going to use the [web-classification](https://github.com/microsoft/prompt an example to show how to deploy with docker. Please ensure you have [create the connection](../manage-connections.md#create-a-connection) required by flow, if not, you could -refer to [Setup connection for web-classifiction](https://github.com/microsoft/promptflow/tree/main/examples/flows/standard/web-classification#1-setup-connection). +refer to [Setup connection for web-classifiction](https://github.com/microsoft/promptflow/tree/main/examples/flows/standard/web-classification). ## Build a flow as docker format app diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md index 20ef41352b7..d5d4e44e979 100644 --- a/docs/tutorials/index.md +++ b/docs/tutorials/index.md @@ -22,7 +22,7 @@ This section contains a collection of flow samples and step-by-step tutorials. |Standard Flow|[basic-with-builtin-llm](https://github.com/microsoft/promptflow/tree/main/examples/flows/standard/basic-with-builtin-llm)| a basic flow using builtin llm tool |Standard Flow|[customer-intent-extraction](https://github.com/microsoft/promptflow/tree/main/examples/flows/standard/customer-intent-extraction)| a flow created from existing langchain python code |Standard Flow|[web-classification](https://github.com/microsoft/promptflow/tree/main/examples/flows/standard/web-classification)| a flow demonstrating multi-class classification with LLM. Given an url, it will classify the url into one web category with just a few shots, simple summarization and classification prompts. -|Standard Flow|[summarizing-film-with-autogpt](https://github.com/microsoft/promptflow/tree/main/examples/flows/standard/summarizing-film-with-autogpt)| a flow showcasing how to construct a AutoGPT flow to autonomously figures out how to apply the given functions to solve the goal, which is film trivia that provides accurate and up-to-date information about movies, directors, actors, and more. +|Standard Flow|[autonomous-agent](https://github.com/microsoft/promptflow/tree/main/examples/flows/standard/autonomous-agent)| a flow showcasing how to construct a AutoGPT flow to autonomously figures out how to apply the given functions to solve the goal, which is film trivia that provides accurate and up-to-date information about movies, directors, actors, and more. |Chat Flow|[chat-with-wikipedia](https://github.com/microsoft/promptflow/tree/main/examples/flows/chat/chat-with-wikipedia)| a flow demonstrating Q&A with GPT3.5 using information from Wikipedia to make the answer more grounded. |Chat Flow|[chat-with-pdf](https://github.com/microsoft/promptflow/tree/main/examples/flows/chat/chat-with-pdf)| a flow that allow you to ask questions about the content of a PDF file and get answers. |Evaluation Flow|[eval-classification-accuracy](https://github.com/microsoft/promptflow/tree/main/examples/flows/evaluation/eval-classification-accuracy)| a flow illustrating how to evaluate the performance of a classification system. diff --git a/examples/README.md b/examples/README.md index 8d0cd66ea63..2b6928d41b0 100644 --- a/examples/README.md +++ b/examples/README.md @@ -101,4 +101,4 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope ## Reference -* [Promptflow documentation](https://microsoft.github.io/promptflow) \ No newline at end of file +* [Promptflow documentation](https://microsoft.github.io/promptflow/) \ No newline at end of file diff --git a/examples/tutorials/flow-deploy/azure-app-service/README.md b/examples/tutorials/flow-deploy/azure-app-service/README.md index 7f757a025c6..b15677cd44b 100644 --- a/examples/tutorials/flow-deploy/azure-app-service/README.md +++ b/examples/tutorials/flow-deploy/azure-app-service/README.md @@ -44,11 +44,11 @@ Note that the `name` will produce a unique FQDN as AppName.azurewebsites.net. See the full parameters by `bash deploy.sh -h` or `.\deploy.ps1 -h`. ## View and test the web app -The web app can be found via [azure portal](https://ms.portal.azure.com/) +The web app can be found via [azure portal](https://portal.azure.com/) ![img](assets/azure_portal_img.png) -After the app created, you will need to go to https://ms.portal.azure.com/ find the app and set up the environment variables +After the app created, you will need to go to https://portal.azure.com/ find the app and set up the environment variables at (Settings>Configuration) or (Settings>Environment variables), then restart the app. ![img](assets/set_env_var.png) diff --git a/examples/tutorials/flow-deploy/azure-app-service/deploy.ps1 b/examples/tutorials/flow-deploy/azure-app-service/deploy.ps1 index b658c71b6aa..8ceaaeba24c 100644 --- a/examples/tutorials/flow-deploy/azure-app-service/deploy.ps1 +++ b/examples/tutorials/flow-deploy/azure-app-service/deploy.ps1 @@ -165,7 +165,7 @@ Invoke-Expression-And-Check "$Command" Write-Host "Config app...$Name" $Command="az webapp config appsettings set -g $ResourceGroup --name $Name --settings USER_AGENT=promptflow-appservice ('@settings.json')" Invoke-Expression-And-Check "$Command" -Write-Host "Please go to https://ms.portal.azure.com/ to config environment variables and restart the app: $Name at (Settings>Configuration) or (Settings>Environment variables)" +Write-Host "Please go to https://portal.azure.com/ to config environment variables and restart the app: $Name at (Settings>Configuration) or (Settings>Environment variables)" Write-Host "Reach deployment logs at (Deployment>Deployment Central) and app logs at (Monitoring>Log stream)" Write-Host "Reach advanced deployment tools at https://$Name.scm.azurewebsites.net/" Write-Host "Reach more details about app service at https://learn.microsoft.com/en-us/azure/app-service/" diff --git a/examples/tutorials/flow-deploy/azure-app-service/deploy.sh b/examples/tutorials/flow-deploy/azure-app-service/deploy.sh index be05f442400..2c75fad66cd 100644 --- a/examples/tutorials/flow-deploy/azure-app-service/deploy.sh +++ b/examples/tutorials/flow-deploy/azure-app-service/deploy.sh @@ -182,7 +182,7 @@ command="az webapp config appsettings set -g $resource_group --name $name --sett command=$(append_to_command "$command") echo "$command" eval "$command" -echo "Please go to https://ms.portal.azure.com/ to config environment variables and restart the app: $name at (Settings>Configuration) or (Settings>Environment variables)" +echo "Please go to https://portal.azure.com/ to config environment variables and restart the app: $name at (Settings>Configuration) or (Settings>Environment variables)" echo "Reach deployment logs at (Deployment>Deployment Central) and app logs at (Monitoring>Log stream)" echo "Reach advanced deployment tools at https://$name.scm.azurewebsites.net/" echo "Reach more details about app service at https://learn.microsoft.com/en-us/azure/app-service/" diff --git a/scripts/docs/conf.py b/scripts/docs/conf.py index aaa9b788dd8..01d12c1ed26 100644 --- a/scripts/docs/conf.py +++ b/scripts/docs/conf.py @@ -49,9 +49,6 @@ # Options for the linkcheck builder linkcheck_ignore = [ - r"https://(ms\.)?portal\.azure\.com/", - r"https://aka\.ms/acs-doc", - r"https://github\.com/microsoft/promptflow", r"https://platform\.openai\.com/", # These are used in card links, for example 'xx.html', .md can't be resolved. r"^(?!https?)", diff --git a/scripts/readme/ghactions_driver/readme_templates/README.md.jinja2 b/scripts/readme/ghactions_driver/readme_templates/README.md.jinja2 index f4d85b54524..a5c7b5e71e9 100644 --- a/scripts/readme/ghactions_driver/readme_templates/README.md.jinja2 +++ b/scripts/readme/ghactions_driver/readme_templates/README.md.jinja2 @@ -87,4 +87,4 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope ## Reference -* [Promptflow documentation](https://microsoft.github.io/promptflow) +* [Promptflow documentation](https://microsoft.github.io/promptflow/) diff --git a/src/promptflow/README.md b/src/promptflow/README.md index a73e6fb2f67..d7f06f69de6 100644 --- a/src/promptflow/README.md +++ b/src/promptflow/README.md @@ -22,6 +22,6 @@ With prompt flow, you will be able to: ## Get Started with Prompt flow ⚡ -Develop your LLM apps with Prompt flow: please start with our [docs](https://microsoft.github.io/promptflow) & [examples](https://github.com/microsoft/promptflow/blob/main/examples/README.md): +Develop your LLM apps with Prompt flow: please start with our [docs](https://microsoft.github.io/promptflow/) & [examples](https://github.com/microsoft/promptflow/blob/main/examples/README.md): - [Getting Started with Prompt Flow](https://microsoft.github.io/promptflow/how-to-guides/quick-start.html): A step by step guidance to invoke your first flow run. - [Tutorial: Chat with PDF](https://github.com/microsoft/promptflow/blob/main/examples/tutorials/e2e-development/chat-with-pdf.md): An end-to-end tutorial on how to build a high quality chat application with prompt flow, including flow development and evaluation with metrics. diff --git a/src/promptflow/promptflow/_sdk/data/docker/deploy.ps1.jinja2 b/src/promptflow/promptflow/_sdk/data/docker/deploy.ps1.jinja2 index b4ddde4d79b..6dc849dc753 100644 --- a/src/promptflow/promptflow/_sdk/data/docker/deploy.ps1.jinja2 +++ b/src/promptflow/promptflow/_sdk/data/docker/deploy.ps1.jinja2 @@ -146,7 +146,7 @@ Invoke-Expression-And-Check "$Command" Write-Host "Config app...$Name" $Command="az webapp config appsettings set -g $ResourceGroup --name $Name --settings USER_AGENT=promptflow-appservice ('@settings.json')" Invoke-Expression-And-Check "$Command" -Write-Host "Please go to https://ms.portal.azure.com/ to config environment variables and restart the app: $Name at (Settings>Configuration) or (Settings>Environment variables)" +Write-Host "Please go to https://portal.azure.com/ to config environment variables and restart the app: $Name at (Settings>Configuration) or (Settings>Environment variables)" Write-Host "Reach deployment logs at (Deployment>Deployment Central) and app logs at (Monitoring>Log stream)" Write-Host "Reach advanced deployment tools at https://$Name.scm.azurewebsites.net/" Write-Host "Reach more details about app service at https://learn.microsoft.com/en-us/azure/app-service/" diff --git a/src/promptflow/promptflow/_sdk/data/docker/deploy.sh.jinja2 b/src/promptflow/promptflow/_sdk/data/docker/deploy.sh.jinja2 index b3391fd6488..b2fd3c8ff58 100644 --- a/src/promptflow/promptflow/_sdk/data/docker/deploy.sh.jinja2 +++ b/src/promptflow/promptflow/_sdk/data/docker/deploy.sh.jinja2 @@ -162,7 +162,7 @@ command="az webapp config appsettings set -g $resource_group --name $name --sett command=$(append_to_command "$command") echo "$command" eval "$command" -echo "Please go to https://ms.portal.azure.com/ to config environment variables and restart the app: $name at (Settings>Configuration) or (Settings>Environment variables)" +echo "Please go to https://portal.azure.com/ to config environment variables and restart the app: $name at (Settings>Configuration) or (Settings>Environment variables)" echo "Reach deployment logs at (Deployment>Deployment Central) and app logs at (Monitoring>Log stream)" echo "Reach advanced deployment tools at https://$name.scm.azurewebsites.net/" echo "Reach more details about app service at https://learn.microsoft.com/en-us/azure/app-service/" diff --git a/src/promptflow/tests/test_configs/flows/export/linux/deploy.ps1 b/src/promptflow/tests/test_configs/flows/export/linux/deploy.ps1 index a2b6477f8bb..11de92c8504 100644 --- a/src/promptflow/tests/test_configs/flows/export/linux/deploy.ps1 +++ b/src/promptflow/tests/test_configs/flows/export/linux/deploy.ps1 @@ -144,7 +144,7 @@ Invoke-Expression-And-Check "$Command" Write-Host "Config app...$Name" $Command="az webapp config appsettings set -g $ResourceGroup --name $Name --settings USER_AGENT=promptflow-appservice ('@settings.json')" Invoke-Expression-And-Check "$Command" -Write-Host "Please go to https://ms.portal.azure.com/ to config environment variables and restart the app: $Name at (Settings>Configuration) or (Settings>Environment variables)" +Write-Host "Please go to https://portal.azure.com/ to config environment variables and restart the app: $Name at (Settings>Configuration) or (Settings>Environment variables)" Write-Host "Reach deployment logs at (Deployment>Deployment Central) and app logs at (Monitoring>Log stream)" Write-Host "Reach advanced deployment tools at https://$Name.scm.azurewebsites.net/" Write-Host "Reach more details about app service at https://learn.microsoft.com/en-us/azure/app-service/" diff --git a/src/promptflow/tests/test_configs/flows/export/linux/deploy.sh b/src/promptflow/tests/test_configs/flows/export/linux/deploy.sh index af2623c3c23..e45d2a6662f 100644 --- a/src/promptflow/tests/test_configs/flows/export/linux/deploy.sh +++ b/src/promptflow/tests/test_configs/flows/export/linux/deploy.sh @@ -162,7 +162,7 @@ command="az webapp config appsettings set -g $resource_group --name $name --sett command=$(append_to_command "$command") echo "$command" eval "$command" -echo "Please go to https://ms.portal.azure.com/ to config environment variables and restart the app: $name at (Settings>Configuration) or (Settings>Environment variables)" +echo "Please go to https://portal.azure.com/ to config environment variables and restart the app: $name at (Settings>Configuration) or (Settings>Environment variables)" echo "Reach deployment logs at (Deployment>Deployment Central) and app logs at (Monitoring>Log stream)" echo "Reach advanced deployment tools at https://$name.scm.azurewebsites.net/" echo "Reach more details about app service at https://learn.microsoft.com/en-us/azure/app-service/"