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.

Sign up for GitHub

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

Jump to bottom

Remove section "Bugs and Stability" from user guide #9354

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Remove section "Bugs and Stability" from user guide #9354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ec04346
Remove sec "Bugs and Stability" from user guide
Oct 19, 2023
0207a16
Add a welcome landing page to the user guide
Oct 21, 2023
39e8e1b
Move information about stability of Setup.hs interface
Oct 22, 2023
45c17ea
Remove how-to-report-bugs.rst file
Nov 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 0 additions & 93 deletions doc/cabal-interface-stability.rst
View file
Open in desktop

This file was deleted.

9 changes: 0 additions & 9 deletions doc/how-to-report-bugs.rst
View file
Open in desktop

This file was deleted.

7 changes: 5 additions & 2 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
Welcome to the Cabal User Guide
===============================

.. toctree::

welcome


.. toctree::
:caption: Getting Started
:numbered:
Expand All @@ -15,7 +20,6 @@ Welcome to the Cabal User Guide

how-to-package-haskell-code
how-to-build-like-nix
how-to-report-bugs

.. toctree::
:caption: Cabal Reference
Expand All @@ -37,4 +41,3 @@ Welcome to the Cabal User Guide

cabal-context
package-concepts
cabal-interface-stability
17 changes: 17 additions & 0 deletions doc/setup-commands.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1379,3 +1379,20 @@ This command takes the following option:


.. include:: references.inc

Stability of the Setup.hs interface
-----------------------------------

The following part of the Setup.hs commandline interface is considered to be very stable.

- ``./setup configure``
- ``--prefix``
- ``--user``
- ``--ghc``, ``--uhc``
- ``--verbose``
- ``--prefix``

- ``./setup build``
- ``./setup install``
- ``./setup register``
- ``./setup copy``
21 changes: 21 additions & 0 deletions doc/welcome.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Welcome
=======

Welcome to the Cabal user guide.
Cabal is the "common architecture for building applications and tools" and consists of a fileformat for describing Haskell packages, a library for working with those files, and a commandline tool for downloading, building and running Haskell applications and libraries.

Comment on lines +1 to +6
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the lower part becomes a dedicated page, would this section make more sense on the getting-started page?

Finding Help
------------

If you are new to Haskell and Cabal, then you can find help in the `Haskell Matrix <https://matrix.to/#/#haskell:matrix.org>`__ chat or on the official `Haskell Discourse <https://discourse.haskell.org>`__ forum.

If you want to contact the maintainers and developers of cabal, then you can join the `Cabal and Hackage Matrix <https://matrix.to/#/#hackage:matrix.org>`__ chat.
If you prefer to use mailing lists, then you can follow `[email protected] <https://mail.haskell.org/mailman/listinfo/libraries>`__ for general discussion and queries about the library ecosystem, and `[email protected] <https://mail.haskell.org/mailman/listinfo/cabal-devel>`__ for the development of Cabal.

Reporting Issues and Requesting Features
----------------------------------------

Cabal is developed on `GitHub <https://github.com/haskell/cabal>`__.
Please report any flaws or feature requests on the `issue
tracker <https://github.com/haskell/cabal/issues>`__.
If you want to start contributing to Cabal yourself, then you can find help in the `CONTRIBUTING.md <https://github.com/haskell/cabal/blob/master/CONTRIBUTING.md>`__ in the repository.
Comment on lines +7 to +21
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about moving this section into a separate guide page like https://github.com/haskell/cabal/pull/9379/files#diff-495e1081527403be1d72a3ae8c14fa5cfa19754bffd27c7b6f4455fa589d1836? It would help with SEO to have the page slug also mention "how-to-get-help-report-issues".

Loading