Atlaskit documentation links are wrong?

Atlassian Developer Tools
#1

A lot of links to Component docs from https://atlaskit.atlassian.com link to the docs built from the pre-release “Atlaskit MK-2” (see link below). These pre-release docs lack a fair few important components (like Text Field). The repo proclaims itself as “… a spike of the potential new build system to be shared by Atlaskit, Media and Fabric.” I’m guessing linking to this is a mistake?

Since the UI looks identical, it’s really hard to figure out why core components have gone missing and I’m scared I’m reading docs for something other than I will get from npm.

Links:
https://ak-mk-2-prod.netlify.com/mk-2/packages/elements/modal-dialog
https://bitbucket.org/atlassian/atlaskit-mk-2

Cheers

#2

Hey @edave

Where exactly are you finding the link to the pre-release docs?

Thanks,
Ralph

#3

Oh I see some components are linking to the prerelease link you provided and some are not.

I’ll share this with the team.

#4

Hey Dave :slight_smile:

We outgrew the architecture of our original repo, and rather than supporting 2 build systems in the same repo, we decided to build a new one and port things over. We’re nearly done (heading into the last sprint for it) and I apologise for the confusion in the current docs. I’d recommend just using the source code as the source of truth until the migration is complete. If a component’s src isn’t in https://bitbucket.org/atlassian/atlaskit-mk-2/src/ then it hasn’t been migrated and will be in https://bitbucket.org/atlassian/atlaskit/src/.

Again, we’re trying to minimise the confusion, but there are a lot of components to migrate across :slight_smile:

Let me know if there’s anything in particular you need help with (or ping me on Twitter).

1 Like
#5

Thanks Sean. :slight_smile: Shall do. Glad to see you’re on this project. Loving your work. :+1:

#6

Thanks Sean - any chance we could get a heads-up regarding changes like this in the future?

Then we don’t have to worry about where all the code has gone/which npm package we should use/which documentation we should read?

#7

Hi Sean,

At the moment it doesn’t appear to be possible to raise issues against the new Bitbucket repo. Can you get that updated so I can provide some feedback on one of the new components?

Thanks,
Jon

1 Like