Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ground hog day documentation. Escaped from the never ending loop and never got anywhere #47

Open
tacklers opened this issue Oct 11, 2021 · 3 comments

Comments

@tacklers
Copy link

Great product I expect.

Shame the guides are not even 5% as good as Microsoft CrmSvCUtil.

Click here for more details? How to run XrmContext? I have no idea.

Setup Instructions. generate Context. No help same loop.

Getting started. generate the context? Takes you back to the same text. Groundhog day.

More gooogling and found a powershell script, looked close but nah.

Non-devs and devs walk away from loading a phone app if it takes more than 30 seconds.

If you write a good bit of code then its worth getting it used, its not clever to have bad documentation.

Disappointed. Richard

@misoeli
Copy link
Member

misoeli commented Oct 12, 2021

I'm sorry to hear you didn't have any luck setting up XrmContext. We're well aware the documentation is lacking, and in some scenarios also outdated. Mostly, the issues regard authentication, which are documented here (though, I'll admit, needs a bit of additional context). All examples there are for the F# version of our scripts - the arguments are similarly named for the cmd line version, as detailed on the Generate Context wiki page.

Feel free to reach out if you're still experiencing issues, though I will need additional insights into your project setup to have any chance of further helping.

(And FYI - we are looking into the documentation on our tools in general.)

@RemyDuijkeren
Copy link

RemyDuijkeren commented Dec 11, 2021

I also have a big problem with the documentation. I use this lib because it's much better than CrmSvCUtil. I see a lot of clever things to make our lives easier, but I simple don't know how to use them. Which is a shame.

I have no clue how to use things like:

  • get the name of the OptionSetmetadata
  • GetColumnName (like this SystemUser.GetColumnName<SystemUser>(e => e.FirstName) ?)
  • GetColumnSet
  • other extensions methods.

I like to improve stuff in XrmContext and Daxif, but I don't know F#. What I can do is add documentation to helpe you out, but I need pointers here and there, to make the correct documentation. Maby you can share some examples how you use the XrmContext in your projects, so I can make documentation for that?

Because of the bad documentation, it is losing a lot of appeal to other developers to use this lib. It took me days to generate a context in C# code working (after much trial and error, looking into the F# source code, importing F# types),

@misoeli
Copy link
Member

misoeli commented Dec 13, 2021

Thank you for your input @remyvd - as already mentioned, looking into and improving the documentation is highly prioritised, but available time is hard to come by.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants