-
Notifications
You must be signed in to change notification settings - Fork 16
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 readme introduction and title #27
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this update! Looks good!
readme.rst
Outdated
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/). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
Added the well needed newlines as you suggested (:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
readme.rst
Outdated
@@ -1,5 +1,10 @@ | |||
Launchpad Documentation Manual |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
readme.rst
Outdated
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/). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
readme.rst
Outdated
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/). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are a couple of things that need to be fixed, see inline comments.
readme.rst
Outdated
@@ -1,23 +1,51 @@ | |||
Launchpad Manual | |||
============================== |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is rst, so you need to have the underline the same length as the heading.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
readme.rst
Outdated
Launchpad Manual | ||
============================== | ||
|
||
Welcome to the official Launchpad Documentation Manual. This manual is designed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The name is "Launchpad Manual", not "Launchpad Documentation Manual".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
readme.rst
Outdated
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The formatting looks broken.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
|
||
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
readme.rst
Outdated
|
||
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/). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The link is formatted in Markdown syntax, but we use the rst format here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot!
Simple introductory paragraph with a title change