Update readme introduction and title #27

RuinedYourLife · 2024-03-22T15:31:58Z

Simple introductory paragraph with a title change

ineesalmeida

Thank you for this update! Looks good!

ineesalmeida · 2024-03-26T15:34:16Z

readme.rst

+Launchpad Documentation Manual
+==============================
+
+Welcome to the official Launchpad Documentation Manual. This manual is designed to help users, developers, and contributors understand and utilize the extensive features of Launchpad more effectively. It covers a wide range of topics, from basic navigation within Launchpad to advanced features such as code hosting, bug tracking, and translations. The documentation is structured to provide guidance for all levels of users, whether you are new to Launchpad or an experienced user looking to deepen your knowledge. This manual is continuously updated to reflect the latest features and improvements. You can access the latest version of the documentation at [https://documentation.ubuntu.com/launchpad/en/latest/](https://documentation.ubuntu.com/launchpad/en/latest/).


The text sounds great 👍

Only thing I'd do is add a couple of new-lines at

bug tracking, and translations. \n The documentation

and

latest features and improvements. \n You can access the lat

But that's mostly personal preference.

Nice!
Added the well needed newlines as you suggested (:

Yes, please wrap the lines after 80 characters - except for links. We probably should either specify this or set up a formatter/linter to make aware of this - sorry for these kind of nitpicks.

As mentioned above, we will have two places for documentation. The other one will be focused on non-public information, this one on public one, and will address both Launchpad users and Launchpad developers such as the Launchpad team. Maybe you could reflect this in the text?

Thank you!

added a paragraph that clarifies the existence of both a public and private manual depending what your needs are and who you are

also hard wrapped lines after 80 characters

jugmac00

Thanks, this looks great already! I have some suggestions of which you could not be aware beforehand - please apply them before we merge this MP.

jugmac00 · 2024-03-26T15:51:00Z

readme.rst

@@ -1,5 +1,10 @@
+Launchpad Documentation Manual


Could you please change this to "Launchpad Manual"? This will be the name, rather than a description.

We will have this one, and another one for non-public things, which will be called the "Launchpad Admin Manual".

jugmac00 · 2024-03-26T15:59:35Z

readme.rst

+Launchpad Documentation Manual
+==============================
+
+Welcome to the official Launchpad Documentation Manual. This manual is designed to help users, developers, and contributors understand and utilize the extensive features of Launchpad more effectively. It covers a wide range of topics, from basic navigation within Launchpad to advanced features such as code hosting, bug tracking, and translations. The documentation is structured to provide guidance for all levels of users, whether you are new to Launchpad or an experienced user looking to deepen your knowledge. This manual is continuously updated to reflect the latest features and improvements. You can access the latest version of the documentation at [https://documentation.ubuntu.com/launchpad/en/latest/](https://documentation.ubuntu.com/launchpad/en/latest/).


Yes, please wrap the lines after 80 characters - except for links. We probably should either specify this or set up a formatter/linter to make aware of this - sorry for these kind of nitpicks.

jugmac00 · 2024-03-26T16:00:53Z

readme.rst

+Launchpad Documentation Manual
+==============================
+
+Welcome to the official Launchpad Documentation Manual. This manual is designed to help users, developers, and contributors understand and utilize the extensive features of Launchpad more effectively. It covers a wide range of topics, from basic navigation within Launchpad to advanced features such as code hosting, bug tracking, and translations. The documentation is structured to provide guidance for all levels of users, whether you are new to Launchpad or an experienced user looking to deepen your knowledge. This manual is continuously updated to reflect the latest features and improvements. You can access the latest version of the documentation at [https://documentation.ubuntu.com/launchpad/en/latest/](https://documentation.ubuntu.com/launchpad/en/latest/).


As mentioned above, we will have two places for documentation. The other one will be focused on non-public information, this one on public one, and will address both Launchpad users and Launchpad developers such as the Launchpad team. Maybe you could reflect this in the text?

Thank you!

jugmac00

There are a couple of things that need to be fixed, see inline comments.

jugmac00 · 2024-04-29T12:11:05Z

readme.rst

@@ -1,23 +1,51 @@
+Launchpad Manual
+==============================


This is rst, so you need to have the underline the same length as the heading.

jugmac00 · 2024-04-29T12:11:33Z

readme.rst

+Launchpad Manual
+==============================
+
+Welcome to the official Launchpad Documentation Manual. This manual is designed


The name is "Launchpad Manual", not "Launchpad Documentation Manual".

jugmac00 · 2024-04-29T12:13:33Z

readme.rst

+   alpha-docs rm -rf .git git init git branch -m main UPDATE THE CONFIGURATION
+   AND BUILD THE DOCS git add -A git commit -m "Import sphinx-docs-starter-pack"
+   git remote add upstream [email protected]:canonical/alpha-docs git push -f
+   upstream main


The formatting looks broken.

jugmac00 · 2024-04-29T12:14:56Z

readme.rst


 Change log
 ----------

-See the `change log <https://github.com/canonical/sphinx-docs-starter-pack/wiki/Change-log>`_ for a list of relevant changes to the starter pack.
+See the `change log


I do not know from the top of my head whether this works, or whether you need to have the link on a single line, which I noted I would not mind if that is the case.

We have a couple of those cases in that file. If this works, ok, go forward, if not you could use the syntax where you only have the link text in the paragraph and the link syntax only used after the paragraph, see third example in https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html#links-to-external-web-pages

this looks fine with the new line it seems! kept it this way

jugmac00 · 2024-04-29T12:21:07Z

readme.rst

+
+This manual is continuously updated to reflect the latest features and
+improvements. You can access the latest version of the documentation at
+[https://documentation.ubuntu.com/launchpad/en/latest/](https://documentation.ubuntu.com/launchpad/en/latest/).


The link is formatted in Markdown syntax, but we use the rst format here.

jugmac00

Thanks a lot!

feat: introduction & title change

695e727

ineesalmeida approved these changes Mar 26, 2024

View reviewed changes

fix: newlines

0389045

jugmac00 requested changes Mar 26, 2024

View reviewed changes

fix: title, public&private doc, line wrap

fe8ea85

jugmac00 requested changes Apr 29, 2024

View reviewed changes

fix: links & format

e17c722

jugmac00 approved these changes Apr 30, 2024

View reviewed changes

jugmac00 merged commit d6bf481 into canonical:main Apr 30, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update readme introduction and title #27

Update readme introduction and title #27

RuinedYourLife commented Mar 22, 2024

ineesalmeida left a comment

ineesalmeida Mar 26, 2024

RuinedYourLife Mar 26, 2024

jugmac00 Mar 26, 2024

jugmac00 Mar 26, 2024

RuinedYourLife Apr 29, 2024 •

edited

Loading

jugmac00 left a comment

jugmac00 Mar 26, 2024

RuinedYourLife Apr 29, 2024

jugmac00 Mar 26, 2024

jugmac00 Mar 26, 2024

jugmac00 left a comment

jugmac00 Apr 29, 2024

RuinedYourLife Apr 29, 2024

jugmac00 Apr 29, 2024

RuinedYourLife Apr 29, 2024

jugmac00 Apr 29, 2024

RuinedYourLife Apr 29, 2024

jugmac00 Apr 29, 2024

RuinedYourLife Apr 29, 2024

jugmac00 Apr 29, 2024

RuinedYourLife Apr 29, 2024

jugmac00 left a comment

		@@ -1,23 +1,51 @@
		Launchpad Manual
		==============================

Update readme introduction and title #27

Update readme introduction and title #27

Conversation

RuinedYourLife commented Mar 22, 2024

ineesalmeida left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RuinedYourLife Apr 29, 2024 • edited Loading

Choose a reason for hiding this comment

jugmac00 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jugmac00 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jugmac00 left a comment

Choose a reason for hiding this comment

RuinedYourLife Apr 29, 2024 •

edited

Loading