Merge ~jugmac00/lpci:known-issues into lpci:main

Proposed by Jürgen Gmach
Status: Merged
Merged at revision: 334507a12bcc55368328fe4893413edf81aa401d
Proposed branch: ~jugmac00/lpci:known-issues
Merge into: lpci:main
Diff against target: 89 lines (+47/-10)
4 files modified
CONTRIBUTING.rst (+0/-7)
docs/cli-interface.rst (+3/-3)
docs/index.rst (+1/-0)
docs/support.rst (+43/-0)
Reviewer Review Type Date Requested Status
Colin Watson (community) Approve
Review via email: mp+433279@code.launchpad.net

Commit message

Add support page

To post a comment you must log in.
Revision history for this message
Colin Watson (cjwatson) wrote :

I think you forgot a `git add` here?

Revision history for this message
Jürgen Gmach (jugmac00) wrote :

Indeed - sorry for that.

I have a variety of .launchpad.yaml files in my working directory...

If you do not mind, I will create a follow-up MP with a gitignore for a test-configuration folder.

Revision history for this message
Colin Watson (cjwatson) :
review: Approve
Revision history for this message
Jürgen Gmach (jugmac00) :

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
2index 64753c6..cf95e75 100644
3--- a/CONTRIBUTING.rst
4+++ b/CONTRIBUTING.rst
5@@ -86,10 +86,3 @@ Build the documentation locally.
6 <https://lpcraft.readthedocs.io/en/latest/>`_ online,
7 after having pushed your changes to the repository, you need to trigger a
8 manual build on the project's dashboard on https://readthedocs.org.
9-
10-Getting help
11-------------
12-
13-If you find bugs in this package, you can report them here:
14-
15- https://launchpad.net/lpcraft
16diff --git a/docs/cli-interface.rst b/docs/cli-interface.rst
17index 3edffa0..afb6907 100644
18--- a/docs/cli-interface.rst
19+++ b/docs/cli-interface.rst
20@@ -1,6 +1,6 @@
21-=======================
22-lpcraft - CLI interface
23-=======================
24+=============
25+CLI interface
26+=============
27
28 Please note that this is only a small selection of the available commands and
29 options.
30diff --git a/docs/index.rst b/docs/index.rst
31index 9e8dfce..488b44c 100644
32--- a/docs/index.rst
33+++ b/docs/index.rst
34@@ -58,5 +58,6 @@ Example configuration
35 cli-interface
36 plugins
37 CONTRIBUTING
38+ support
39 release-process
40 NEWS
41diff --git a/docs/support.rst b/docs/support.rst
42new file mode 100644
43index 0000000..5746f8d
44--- /dev/null
45+++ b/docs/support.rst
46@@ -0,0 +1,43 @@
47+Support
48+=======
49+
50+Getting help
51+------------
52+
53+In case you need help, do not hesitate to reach out to us:
54+
55+ https://answers.launchpad.net/lpcraft
56+
57+If you work at Canonical, you can also visit the ~Launchpad channel on
58+Mattermost.
59+
60+
61+Bugs and feature requests
62+-------------------------
63+
64+If you encounter a bug or you would like to have a new feature implemented,
65+please report them at https://bugs.launchpad.net/lpcraft.
66+
67+
68+Known issues
69+------------
70+
71+Apart from the currently open
72+`bug reports <https://bugs.launchpad.net/lpcraft>`_,
73+there are the following known issues for which there is no known solution:
74+
75+- In order to keep the source tree clean,
76+ lpcraft mirrors the contents of the project into the lxd container
77+ (``/build/lpcraft/project/``).
78+
79+ This may have unexpected side effects when your current work tree is not
80+ clean.
81+
82+ This may also be a reason that the result you get when you run ``lpcraft``
83+ on your machine and on CI may diverge.
84+
85+ In order to ensure that you can use ``lpcraft`` to test code that has not yet
86+ been committed,
87+ we do not currently intend to change this behaviour.
88+ However, you can simulate the behaviour of a CI run by making a fresh clone
89+ of your branch and running ``lpcraft`` there.

Subscribers

People subscribed via source and target branches