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

Update docs for 3.x release: remove v2- prefix and unflag as experimental #6213

Closed
gbaz opened this issue Aug 29, 2019 · 4 comments · Fixed by #9087
Closed

Update docs for 3.x release: remove v2- prefix and unflag as experimental #6213

gbaz opened this issue Aug 29, 2019 · 4 comments · Fixed by #9087

Comments

@gbaz
Copy link
Collaborator

gbaz commented Aug 29, 2019

The cabal users guide still describes the v2- stuff with the prefix and says it is experimental.

https://cabal.readthedocs.io/en/latest/nix-local-build.html

Now that it is the standard path, shouldn't we at least do a small update to the docs to get rid of all the v2- prefix stuff and indicate that this is the normal mode of operation?

@m-renaud
Copy link
Collaborator

See #6194 for some ideas I had to improve the docs, this would include at the minimum updating everything for v2- as the default without the prefix.

@gbaz
Copy link
Collaborator Author

gbaz commented Aug 29, 2019

I think that's a great proposal. But we have a cabal out today that the docs don't explain correctly. We should fix that first, and independently worry about making the docs better. For now let's just make sure they're correct :-)

@m-renaud
Copy link
Collaborator

Reviving this thread :) @gbaz are there specific concerns you have about updating docs to move to 3.0 now considering how long it has been the default?

To me fixing any incorrectness in existing docs and switching to 3.0 seem completely orthogonal to one another. If you can give me some specific actionable changes you'd like to see I can take a look at those, otherwise I'd like to decouple them and move forward with updating the references to v2. Let me know!

@jneira jneira changed the title Update docs for 3.0 release Update docs for 3.x release: remove v2- prefix and unflag as experimental Jun 13, 2021
@ulysses4ever
Copy link
Collaborator

Looks like it will be closed by #9087.

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

Successfully merging a pull request may close this issue.

4 participants