Fluentui: Fabric Website: Add support for versioned documentation

Created on 30 Nov 2018  路  14Comments  路  Source: microsoft/fluentui

I'm doing development within SPFx.
Is there somewhere documentation for v.5?

_Originally posted by @cliffkoh in https://github.com/OfficeDev/office-ui-fabric-react/issues/6858#issuecomment-433995571_

Documentation Website

Most helpful comment

I realized that I could get the documentation website from branch 5.0
That's enough for me.
Thank's you all guys

All 14 comments

@Jahnp Is there any way we could deploy the doc site for v5? (or is there a url we can point to for this?)

Maybe. It'd take a little investigation but it should be feasible.

Thanks guys
I await news

For sure! Off the top of my head, it will probably require the following:

  1. Modifying the website on the v5 branch to use the v6 pipeline format
  2. Re-tooling the v5 build to publish the website from that branch
  3. Setting up an endpoint for the v5 website to consume it
  4. Setting up a v5 release to automate deployment

There's probably more involved and some details I'm missing. Will try to carve out time to investigate & confirm work required over the next few days.

Oh, step 1 right there is going to be a lot of work... It would unblock deployment of the dev site to aka.ms/fabricdemo though.

@cliffkoh It might not actually be that bad. I think we would basically just need to port the changes from #6683 to the 5.0 branch. Haven't dug much deeper than a cursory diff but I think that should do it for all future 5.x releases.

I realized that I could get the documentation website from branch 5.0
That's enough for me.
Thank's you all guys

Sure thing. Closing the issue, given you can access the branch.

After some discussion, we're planning to add support for versioned documentation on the Fabric website. In the beginning, this will allow you to switch between docs for the latest v5 and v6 releases. We'll shoot to have this ready in February.

This should also support this similar issue in the SPFX dev docs.

Oops, accidentally closed--sorry. Was going to say that @leddie24 and I went over the technical plan for this today and will begin prototyping work shortly.

We're close to finishing this work, but have some outstanding work items to finish. We'll go ahead and move this to March--we expect to be finish within the next 1-2 weeks.

Update: This has been launched!

You can now access Fabric v5 docs from the Fabric homepage:
image

Please give this a spin and let us know if you have any issues or questions. We do know that there are some visual bugs in the left nav--we'll track those in a separate issue as we don't believe they're scenario-blocking.

Also, note that the approach we used here is a short-term solution that enables the basic version-switching functionality, but isn't super extensible (e.g. switching between minor & patch versions). In the future, we'll be revisiting the deployment/release pipeline to better load & manage releases more granularly.

Also, massive kudos to @leddie24 for enabling the bulk of this feature!

Closing this for now as a working version of this is complete. We'll continue to invest in more robust version-switching over time.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

quanglefed picture quanglefed  路  33Comments

HarryGifford picture HarryGifford  路  64Comments

jeremy-coleman picture jeremy-coleman  路  63Comments

just-joshing picture just-joshing  路  35Comments

ryancole picture ryancole  路  39Comments