Docs: start basic template#1666
Conversation
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
I just had a look at https://www.whois.com/whois/vfsforgit.org. It seems that Microsoft holds it, but it will expire on July 12th this year... so we might need to get a couple cogs turning to renew it in time. |
Could we renew it to just redirect to this repo? I wonder if @mrfaizal has any idea what that process would look like. |
| * VFS for Git will work with any Git service that supports the | ||
| [GVFS protocol](Protocol.md). For example, you can create a repo in | ||
| [Azure DevOps](https://azure.microsoft.com/services/devops/), and push | ||
| some contents to it. There are two constraints: |
There was a problem hiding this comment.
Do we really want to wrap the .md?
There was a problem hiding this comment.
...yes? It links to the page in the repo. Perhaps I don't understand your comment.
| some contents to it. There are two constraints: | ||
|
|
||
| * Your repo must not enable any clean/smudge filters | ||
| * Your repo must have a `.gitattributes` file in the root that includes |
There was a problem hiding this comment.
Is it "that includes" or "whose contents consists of"?
There was a problem hiding this comment.
I think there are some .gitattributes options that can be added in addition to this one. I don't think an exact value is important.
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Includes the following pull requests: * #1663: Update Git to v2.27.0 * #1669: Docs: more troubleshooting and FAQs * #1668: ProductUPgradeTimer: remove unacceptable Environment.Exit() * #1664: Update USN journal entries for projected folders * #1666: Docs: start basic template * #1658: ProjFSFilter: Be more robust to missing PowerShell
We don't have a lot of user-facing documentation. Someone owns VFSforGit.org but I don't know who. (@ethomson probably knows.)
However, it would be better to have a set of docs in the repo. This provides some basic info for using VFS for Git, especially around the happy path.
To finish #1665, I will update the troubleshooting docs with more advice around the not-so-happy paths.