Pnpjs: What happened to the documentation?

[simkessy]

Haven't used PNP in a couple months, seems pretty different now. What happened to the documentation on how to do various tasks, everything on github is archived now :/

[patrick-rodgers]

Hi @simkessy,

We've been discussing the transition for over 6 months with July 2018 being the archive date and final release of the sp-pnp-js libraries. During that time we had an explanation posted on the readme for sp-pnp-js discussing the move as well as providing a link to the transition guide. The documentation is linked from the readme in this library as well as the readme for sp-pnp-js. The documentation is also linked in the header for this repository. You can also have a look as the getting started guide in the documentation for how to easily add and begin using the new libraries in your applications.

In addition to that we have covered the change in our bi-weekly calls - the recordings for which can be found on our youtube channel. You can find the JS SIG videos in this playlist.

[simkessy]

I see...I'm not sure how you can compare what you guys had in the wiki to https://pnp.github.io/pnpjs/ which essentially shows the bare minimum on getting up and running with no real examples like the wiki provided before.

This page was pretty extensive in explaining what you could do with the library. The link you provided above, well, :/

[koltyakov]

Hi @simkessy,

Did you try drilling down to any of the packages from the index docs page, e.g. sp package?
sp-pnp-js wiki contains 46 pages while new docs at the moment have 68 info pages. I don't believe that new docs miss some info which was in the old lib.

What we really miss now, IMO, is search over the docs, yet it searchable from outside e.g. with something like web site:https://pnp.github.io/pnpjs.

Anyway, it's a sign for us that docs site UX has some gaps to enhance and do more straightforward for the folks to find required article even without knowing of its existence.

[simkessy]

@koltyakov

I see, I was looking at pnpjs instead of sp. Hmm yea maybe a search would be helpful. I don't really see the batch information anymore, it's kind of become a bit more challenging to find how to use pnp compared to before. Probably my fault for now having kept up over the past couple months, at least the old wiki is still available.

[patrick-rodgers]

@simkessy - Can you share some concrete suggestions for improving the docs? We can look at adding a search box (just a scoped bing search). What else would help?

[simkessy]

It could just be me really. For some reason I was having a really hard time getting to what I needed. I think it would help if there was a larger link in the old github repo that pointed directly to the list of topics like (dealing with items, update, add, batch, etc etc.). I was trying to figure out where that was moved too and couldn't find it until I asked.

[simkessy]

"These libraries are based on the sp-pnp-js library and our goal was to make transition as easy as possible. The most obvious difference is the splitting of the library into multiple packages. We have however created a rollup library to help folks make the move - though our recommendation is to switch to the separate packages. This article outlines transitioning your existing projects from sp-pnp-js to the new libraries, please provide feedback on how we can improve out guidance."

I added:https://cdnjs.cloudflare.com/ajax/libs/pnp-pnpjs/1.1.2/pnpjs.es5.umd.min.js to my html file and just got an error

Then I added common:

[koltyakov]

The wrong one to reference in a legacy style projects, please try this https://cdnjs.cloudflare.com/ajax/libs/pnp-pnpjs/1.1.2/pnpjs.es5.umd.bundle.min.js.

[simkessy]

Thank you that helped.

[patrick-rodgers]

Going to close this. Added a search box to the header. If you have other constructive suggestions for the docs we can implement please create a new issue. We are going to look at a "left nav" but unsure on timeline for that. Thanks!