Skip to content

Commit

Permalink
[document] refine doc rule after repo public (microsoft#299)
Browse files Browse the repository at this point in the history
# 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.
  • Loading branch information
wangchao1230 authored Sep 5, 2023
1 parent f46c3ef commit cb21d91
Show file tree
Hide file tree
Showing 17 changed files with 18 additions and 21 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/cloud/azureai/deploy-to-azure-appservice.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to-guides/deploy-a-flow/deploy-using-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
* [Promptflow documentation](https://microsoft.github.io/promptflow/)
4 changes: 2 additions & 2 deletions examples/tutorials/flow-deploy/azure-app-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/"
2 changes: 1 addition & 1 deletion examples/tutorials/flow-deploy/azure-app-service/deploy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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/"
3 changes: 0 additions & 3 deletions scripts/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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?)",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
2 changes: 1 addition & 1 deletion src/promptflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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/"
Original file line number Diff line number Diff line change
Expand Up @@ -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/"
Original file line number Diff line number Diff line change
Expand Up @@ -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/"
Original file line number Diff line number Diff line change
Expand Up @@ -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/"

0 comments on commit cb21d91

Please sign in to comment.