Skip to content

Commit edf4ad0

Browse files
authored
Merge pull request #757 from OfficeDev/main
[admin] Publish
2 parents e58c9f6 + a6a51b1 commit edf4ad0

File tree

2 files changed

+23
-18
lines changed

2 files changed

+23
-18
lines changed

Contributing.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Pull requests are typically reviewed within 10 business days.
6161

6262
## Use GitHub, Git, and this repository
6363

64-
**Note**: Most of the information in this section can be found in [GitHub Help] articles. If you're familiar with Git and GitHub, skip to the **Contribute and edit content** section for the specifics of the code/content flow of this repository.
64+
**Note**: Most of the information in this section can be found in [GitHub Help] articles. If you're familiar with Git and GitHub, skip to the **Contribute and edit content** section for the specifics of the code and content flow of this repository.
6565

6666
### To set up your fork of the repository
6767

@@ -70,12 +70,12 @@ Pull requests are typically reviewed within 10 business days.
7070
3. Create your own fork of this repository. To do this, at the top of the page, choose the **Fork** button.
7171
4. Copy your fork to your computer. To do this, open Git Bash. At the command prompt enter:
7272

73-
git clone https://github.com/<your user name>/<repo name>.git
73+
git clone https://github.com/<your username>/office-scripts-docs.git
7474

7575
Next, create a reference to the root repository by entering these commands:
7676

7777
cd <repo name>
78-
git remote add upstream https://github.com/OfficeDev/<repo name>.git
78+
git remote add upstream https://github.com/OfficeDev/office-scripts-docs.git
7979
git fetch upstream
8080

8181
Congratulations! You've now set up your repository. You won't need to repeat these steps again.
@@ -91,7 +91,7 @@ To make the contribution process as seamless as possible, follow these steps.
9191
3. Submit a pull request to the main repository.
9292
4. Delete the branch.
9393

94-
**Important** Limit each branch to a single concept/article to streamline the work flow and reduce the chance of merge conflicts. Content appropriate for a new branch includes:
94+
**Important** Limit each branch to a single concept or article to streamline the workflow and reduce the chance of merge conflicts. Content appropriate for a new branch includes:
9595

9696
* A new article.
9797
* Spelling and grammar edits.
@@ -100,17 +100,17 @@ To make the contribution process as seamless as possible, follow these steps.
100100
#### To create a new branch
101101

102102
1. Open Git Bash.
103-
2. At the Git Bash command prompt, type `git pull upstream master:<new branch name>`. This creates a new branch locally that is copied from the latest OfficeDev master branch.
103+
2. At the Git Bash command prompt, type `git pull upstream main:<new branch name>`. This creates a new branch locally that is copied from the latest OfficeDev/office-scripts-docs main branch.
104104
3. At the Git Bash command prompt, type `git push origin <new branch name>`. This alerts GitHub to the new branch. You should now see the new branch in your fork of the repository on GitHub.
105105
4. At the Git Bash command prompt, type `git checkout <new branch name>` to switch to your new branch.
106106

107107
#### Add new content or edit existing content
108108

109-
You navigate to the repository on your computer by using File Explorer. The repository files are in `C:\Users\<yourusername>\<repo name>`.
109+
You navigate to the repository on your computer by using File Explorer. The repository files are in `C:\Users\<your username>\office-scripts-docs`.
110110

111111
To edit files, open them in an editor of your choice and modify them. To create a new file, use the editor of your choice and save the new file in the appropriate location in your local copy of the repository. While working, save your work frequently.
112112

113-
The files in `C:\Users\<yourusername>\<repo name>` are a working copy of the new branch that you created in your local repository. Changing anything in this folder doesn't affect the local repository until you commit a change. To commit a change to the local repository, type the following commands in GitBash:
113+
The files in `C:\Users\<your username>\office-scripts-docs` are a working copy of the new branch that you created in your local repository. Changing anything in this folder doesn't affect the local repository until you commit a change. To commit a change to the local repository, type the following commands in Git Bash.
114114

115115
git add .
116116
git commit -v -a -m "<Describe the changes made in this commit>"
@@ -130,38 +130,38 @@ When you're finished with your work and are ready to have it merged into the mai
130130
1. In the Git Bash command prompt, type `git push origin <new branch name>`. In your local repository, `origin` refers to your GitHub repository that you cloned the local repository from. This command pushes the current state of your new branch, including all commits made in the previous steps, to your GitHub fork.
131131
2. On the GitHub site, navigate in your fork to the new branch.
132132
3. Choose the **Pull Request** button at the top of the page.
133-
4. Verify the Base branch is `OfficeDev/<repo name>@master` and the Head branch is `<your username>/<repo name>@<branch name>`.
133+
4. Verify the Base branch is `OfficeDev/office-scripts-docs@main` and the Head branch is `<your username>/office-scripts-docs@<branch name>`.
134134
5. Choose the **Update Commit Range** button.
135135
6. Add a title to your pull request, and describe all the changes you're making.
136136
7. Submit the pull request.
137137

138-
One of the site administrators will process your pull request. Your pull request will surface on the OfficeDev/<repo name> site under Issues. When the pull request is accepted, the issue will be resolved.
138+
One of the site administrators will process your pull request. Your pull request will surface on the `OfficeDev/office-scripts-docs` site under Issues. When the pull request is accepted, the issue will be resolved.
139139

140-
#### Create a new branch after merge
140+
#### Create a new branch after the merge
141141

142142
After a branch is successfully merged (that is, your pull request is accepted), don't continue working in that local branch. This can lead to merge conflicts if you submit another pull request. To do another update, create a new local branch from the successfully merged upstream branch, and then delete your initial local branch.
143143

144-
For example, if your local branch X was successfully merged into the OfficeDev/office-scripts-docs master branch and you want to make additional updates to the content that was merged. Create a new local branch, X2, from the OfficeDev/office-scripts-docs master branch. To do this, open GitBash and execute the following commands:
144+
For example, if your local branch X was successfully merged into the OfficeDev/office-scripts-docs main branch and you want to make additional updates to the content that was merged. Create a new local branch, X2, from the OfficeDev/office-scripts-docs main branch. To do this, open Git Bash and execute the following commands:
145145

146146
cd office-scripts-docs
147-
git pull upstream master:X2
147+
git pull upstream main:X2
148148
git push origin X2
149149

150150
You now have local copies (in a new local branch) of the work that you submitted in branch X. The X2 branch also contains all the work other writers have merged, so if your work depends on others' work (for example, shared images), it is available in the new branch. You can verify that your previous work (and others' work) is in the branch by checking out the new branch...
151151

152152
git checkout X2
153153

154-
...and verifying the content. (The `checkout` command updates the files in `C:\Users\<yourusername>\office-scripts-docs` to the current state of the X2 branch.) Once you check out the new branch, you can make updates to the content and commit them as usual. However, to avoid working in the merged branch (X) by mistake, it's best to delete it (see the following **Delete a branch** section).
154+
...and verifying the content. (The `checkout` command updates the files in `C:\Users\<your username>\office-scripts-docs` to the current state of the X2 branch.) Once you check out the new branch, you can make updates to the content and commit them as usual. However, to avoid working in the merged branch (X) by mistake, it's best to delete it (see the following **Delete a branch** section).
155155

156156
#### Delete a branch
157157

158158
Once your changes are successfully merged into the main repository, delete the branch you used because you no longer need it. Any additional work should be done in a new branch.
159159

160160
#### To delete a branch
161161

162-
1. In the Git Bash command prompt, type `git checkout master`. This ensures that you aren't in the branch to be deleted (which isn't allowed).
162+
1. In the Git Bash command prompt, type `git checkout main`. This ensures that you aren't in the branch to be deleted (which isn't allowed).
163163
2. Next, at the command prompt, type `git branch -d <branch name>`. This deletes the branch on your computer only if it has been successfully merged to the upstream repository. (You can override this behavior with the `–D` flag, but first be sure you want to do this.)
164-
3. Finally, type `git push origin :<branch name>` at the command prompt (a space before the colon and no space after it). This will delete the branch on your github fork.
164+
3. Finally, type `git push origin :<branch name>` at the command prompt (a space before the colon and no space after it). This will delete the branch on your GitHub fork.
165165

166166
Congratulations, you have successfully contributed to the project!
167167

@@ -181,7 +181,7 @@ Fill out the form at [Join GitHub](https://github.com/join) to open a free GitHu
181181

182182
You will automatically be sent a notice that you need to sign the Contributor's License Agreement (CLA) if your pull request requires one.
183183

184-
As a community member, **you must sign the Contribution License Agreement (CLA) before you can contribute large submissions to this project**. You only need complete and submit the documentation once. Carefully review the document. You may be required to have your employer sign the document.
184+
As a community member, **you must sign the Contribution License Agreement (CLA) before you can contribute large submissions to this project**. You only need to complete and submit the documentation once. Carefully review the document. You may be required to have your employer sign the document.
185185

186186
### What happens with my contributions?
187187

@@ -200,7 +200,6 @@ Pull requests are typically reviewed within 10 business days.
200200
* To learn more about Markdown, go to the Markdown creator's site [Daring Fireball].
201201
* To learn more about using Git and GitHub, first check out the [GitHub Help].
202202

203-
[GitHub Home]: http://github.com
204203
[GitHub Help]: http://help.github.com/
205204
[Set up Git]: https://help.github.com/articles/set-up-git/
206205
[Daring Fireball - Markdown]: http://daringfireball.net/projects/markdown/

docs/testing/power-automate-troubleshooting.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Troubleshoot Office Scripts running in Power Automate
33
description: Tips, platform information, and known issues with the integration between Office Scripts and Power Automate.
44
ms.topic: troubleshooting-general
5-
ms.date: 02/08/2024
5+
ms.date: 08/13/2024
66
ms.localizationpriority: medium
77
---
88

@@ -95,6 +95,12 @@ There are two reasons that the parameters or returned data of a script are not a
9595

9696
The signature of a script is stored with the **Excel Business (Online)** connector when it is created. Remove the old connector and create a new one to get the latest parameters and return values for the **Run script** action.
9797

98+
## Some web APIs not available with Power Automate flows
99+
100+
Some web APIs, such as `TextEncoder` and `Crypto`, may not be available when running Office Scripts in Power Automate flows. See [MDN Web APIs](https://developer.mozilla.org/docs/Web/API) for a full list of web APIs.
101+
102+
Power Automate returns the error `*API* is not defined`, where `*API*` specifies a library such as `TextEncoder`, when running a script that uses an unsupported API.
103+
98104
## See also
99105

100106
- [Troubleshoot Office Scripts](troubleshooting.md)

0 commit comments

Comments
 (0)