神刀安全网

Releasing F# Language Documentation as Open-Source

Guest post by Den Delimarsky , Program Manager, Cloud & Enterprise

Continuing our efforts to make our documentation more flexible and open, we are releasing the F# language documentation as open-source . This means that starting today you can both easily download the most up-to-date documents for offline consumption, as well as contribute to sections that you feel require work. All pages within this documentation set are licensed under the  Creative Commons – Attribution-NonCommercial 3.0 Unported .

What changed?

Here is a list of things that changed that you should be aware of. While we are still working on improving and adding features, these are live today.

Friendly URLs

Forget about the ugly MSDN shortlinks. Instead you are now able to see friendly URLs that clearly indicate what page you are linking to. This is something that we will be transitioning to long-term for all MSDN docs. Worth mentioning that none of the old links to F# documents are broken – we worked on setting up graceful redirection, so any references you might have to the old doc pages will automatically point to the new pages with zero effort on your side.

Releasing F# Language Documentation as Open-Source

Documentation entirely hosted on GitHub

We converted the entire F# documentation stack from an older format to a modern and widely-adopted Markdown format . Every single markdown file is now hosted in a single repository where you can download them, edit them and suggest modifications as you see fit. Go to the official repo and see what it’s all about!

Releasing F# Language Documentation as Open-Source

Changes to docs happen within minutes and not days

Gone are the days when we need to wait days before the entire documentation set is rebuilt. Our engineers worked hard on optimizing the publishing system performance – today, once the fix to a doc is in, it is live within minutes, available to user worldwide with no exceptions.

Docs that accept contributions have a ‘Contribute’ button

You don’t have to sift through the GitHub repo to find the doc that you want to download or fix. Simply click on the `Contribute` button in the right corner of the documentation page.

Releasing F# Language Documentation as Open-Source

How to contribute?

Here is the breakdown of steps you need to take to contribute to the docs:

1. Fork the visualfsharpdocs repo . You can do so from the GitHub web UI.

Releasing F# Language Documentation as Open-Source

2. Clone the newly-forked repo locally. The easiest way to do it is through the GitHub Desktop client – just drag the URL from the address bar in the client.

Releasing F# Language Documentation as Open-Source

( click to enlarge )

3. Work on the modifications to the document ( e.g. fix links, wording, etc. ).

4. Create a new pull request into the live branch in the visualfsharpdocs repo. This branch propagates directly to the public MSDN docs.

Releasing F# Language Documentation as Open-Source

That is as simple as it gets! Once the PR is submitted, the automated build system will ensure that there are no issues (and if there are any – you will be alerted about it). Once we validate the change, we will merge the changes and your contributions will be publicly recorded and published.

If you simply would like to report problems with the docs, you can report them by going to the Issues page within the same documentation repo .

Feedback

As this is our first attempt to mass-migrate more than 1700 pages to Markdown through an automated process, we expect that there might be some issues in the new docs. If you find them – report them to us . We are listening to your feedback daily and will be issuing fixes as soon as we diagnose them.

转载本站任何文章请注明:转载至神刀安全网,谢谢神刀安全网 » Releasing F# Language Documentation as Open-Source

分享到:更多 ()

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址