Skip to content

Commit

Permalink
Add initial docs from the learn site
Browse files Browse the repository at this point in the history
  • Loading branch information
mattleibow committed Jul 25, 2024
1 parent 5697445 commit 3a4efb9
Show file tree
Hide file tree
Showing 1,201 changed files with 195,238 additions and 71 deletions.
13 changes: 13 additions & 0 deletions .config/dotnet-tools.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"version": 1,
"isRoot": true,
"tools": {
"docfx": {
"version": "2.77.0",
"commands": [
"docfx"
],
"rollForward": false
}
}
}
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Xamarin doc issue
about: Report a problem in the Xamarin documentation
---

<!-- Before you open an issue
If the issue is:
- A simple typo or similar correction, consider submitting a PR to fix it instead of logging an issue. See [the contributor guide](https://docs.microsoft.com/contribute/#quick-edits-to-existing-documents) for instructions.
- A general support question, ask on a support forum site.
- A site design concern, create an issue at [MicrosoftDocs/feedback](https://github.com/MicrosoftDocs/feedback/issues/new/choose).
- A problem completing a tutorial, compare your code with the completed sample.
-->

### Doc issue description

<!-- Describe what the issue with an item of documentation is -->
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: docs.microsoft.com site feedback
url: https://github.com/MicrosoftDocs/feedback/issues/new/choose
about: Log general docs.microsoft.com site issues here
- name: Xamarin product feedback
url: https://developercommunity.visualstudio.com/spaces/8/index.html
about: Log product issues here
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/customer-feedback.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Learn feedback control
description: |
⛔ This template is hooked into the feedback control on the bottom of every page on the live site. It automatically fills in several fields for you. Don't use it for other purposes. ⛔
body:
- type: markdown
attributes:
value: "## Issue information"
- type: markdown
attributes:
value: Select the issue type, and describe the issue in the text box below. Add as much detail as needed to help us resolve the issue.
- type: dropdown
id: issue-type
attributes:
label: Type of issue
options:
- Typo
- Code doesn't work
- Missing information
- Outdated article
- Other (describe below)
validations:
required: true
- type: textarea
id: feedback
validations:
required: true
attributes:
label: Description
- type: markdown
attributes:
value: "## 🚧 Article information 🚧"
- type: markdown
attributes:
value: "*Don't modify the following fields*. They are automatically filled in for you. Doing so will disconnect your issue from the affected article. *Don't edit them*."
- type: input
id: pageUrl
validations:
required: true
attributes:
label: Page URL
- type: input
id: contentSourceUrl
validations:
required: true
attributes:
label: Content source URL
- type: input
id: documentVersionIndependentId
validations:
required: true
attributes:
label: Document Version Independent Id
- type: input
id: author
validations:
required: true
attributes:
label: Article author
- type: textarea
id: metadata
validations:
required: false
attributes:
label: Metadata
description: Documentation metadata will be applied here for the PRMerger tool.
28 changes: 28 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Publish Docs
on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2

- name: DocFX
uses: nikeee/[email protected]
with:
args: docs/docfx.json

- name: Deploy Live
if: github.ref == 'refs/heads/docs'
uses: peaceiris/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./_site/
publish_branch: docs-live
16 changes: 16 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
log/
obj/
_site/
.optemp/
_themes*/
_repo.*/

.openpublishing.buildcore.ps1

# Folder configuration on Mac
.DS_Store

# WebStorm configuration files.
.idea
/.vs
.vscode/settings.json
35 changes: 35 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"default": true,
"MD001": false,
"MD009": false,
"MD013": false,
"MD014": false,
"MD022": false,
"MD024": false,
"MD025": false,
"MD026": false,
"MD028": false,
"MD033": {
"allowed_elements": [
"a",
"p",
"img",
"sup", "sub",
"h3", "h4",
"pre",
"br",
"kbd",
"dl", "dt", "dd",
"ul", "ol", "li",
"T", "View", "TVisual", "VisualElement"
]
},
"MD034": false,
"MD036": false,
"MD040": false,
"MD041": false,
"MD045": false,
"MD046": {
"style": "fenced"
}
}
5 changes: 5 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"recommendations": [
"docsmsft.docs-authoring-pack"
]
}
6 changes: 0 additions & 6 deletions CODE-OF-CONDUCT.md

This file was deleted.

4 changes: 4 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Code of Conduct

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
76 changes: 76 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributing

Thank you for your interest in contributing to the Xamarin documentation!

This page covers the basic process for updating content in the [Xamarin documentation](https://learn.microsoft.com/xamarin).

- [Contributor License Agreement](LICENSE)

## Process for contributing

### Small changes & edits

To make corrections and small updates - you can click the **Edit** button on any page and use the GitHub website to contribute, or follow these steps:

1. Fork the `MicrosoftDocs/xamarin-docs` repo.

2. Create a `branch` for your changes.

3. Write your content. Refer to the [template](contributing-guidelines/template.md) and [style guide](contributing-guidelines/voice-tone.md).

4. Submit a Pull Request (PR) from your branch to `MicrosoftDocs/xamarin-docs/live`.

5. Make any necessary updates to your branch as discussed with the team via the PR.

6. The maintainers will merge your PR once feedback has been applied and your change looks good. It will be published soon after.

> [!NOTE]
> If your PR is addressing an existing issue, add the `Fixes #Issue_Number` keyword to the commit message or PR description, so the issue can be automatically closed when the PR is merged. For more information, see [Closing issues via commit messages](https://help.github.com/articles/closing-issues-via-commit-messages/).
### Big changes or new content

For large contributions and new content, [open an issue](https://github.com/MicrosoftDocs/xamarin-docs/issues) describing the article you wish to write and how it relates to existing content. The content inside the docs folder is organized into sections that are organized by product area (e.g. android and ios). Try to determine the correct folder for your new content.

**Get feedback on your proposal via the issue before starting to write.**

If it's a new topic, you can use the [template file](../contributing-guidelines/template.md) as your starting point. It contains the writing guidelines and also explains the metadata required for each article, such as author information.

For images and other static resources, add them to the subfolder called **\<mypage>-images**. If you are creating a new folder for content, add an images folder to the new folder.

#### Example structure

```
docs
/android
mypage.md
/mypage-images
some-image.png
```

Be sure to follow the proper Markdown syntax. See the [style guide](../contributing-guidelines/template.md) for more information.

The actual submission steps are the same as for small changes ([above](#process-for-contributing)).

The Xamarin team will review your PR and let you know (via PR feedback) if the change looks good or if there are any other updates/changes necessary in order to approve it.

The maintainers will then merge your PR once feedback has been applied and your change looks good.

On a certain cadence, we push all commits from master branch into the live site and then you'll be able to see your contribution at [Xamarin documentation](https://learn.microsoft.com/xamarin/).

### Contributing to International content

Contributions for Machine Translated (MT) content are currently not accepted for now. In an effort to improve the quality of MT content, we've transitioned to a Neural MT engine. We accept and encourage contributions for Human Translated (HT) content, which is used to train the Neural MT engine. So over time, contributions to HT content will improve the quality of both HT and MT. MT topics will have a disclaimer stating that part of the topic may be MT, and the **Edit** button won't be displayed as it's disabled.

## DOs and DON'Ts

Below is a short list of guiding rules that you should keep in mind when you are contributing to the .NET documentation.

- **DON'T** surprise us with big pull requests. Instead, file an issue and start a discussion so we can agree on a direction before you invest a large amount of time.
- **DO** read the [style guide](contributing-guidelines/template.md) and [voice and tone](contributing-guidelines/voice-tone.md) guidelines.
- **DO** use the [template](contributing-guidelines/template.md) file as the starting point of your work.
- **DO** create a separate branch on your fork before working on the articles.
- **DO** follow the [GitHub Flow workflow](https://guides.github.com/introduction/flow/).
- **DO** blog and tweet (or whatever) about your contributions, frequently!

> [!NOTE]
> You might notice that some of the topics are not currently following all the guidelines specified here and on the [style guide](contributing-guidelines/template.md) as well. We're working towards achieving consistency throughout the site.
Loading

0 comments on commit 3a4efb9

Please sign in to comment.