Skip to content

docs: redistribute FAQ content into relevant sections (fix to issue #39)#64

Merged
asanvaq merged 15 commits into
canonical:mainfrom
barbaravalera:main
May 22, 2026
Merged

docs: redistribute FAQ content into relevant sections (fix to issue #39)#64
asanvaq merged 15 commits into
canonical:mainfrom
barbaravalera:main

Conversation

@barbaravalera
Copy link
Copy Markdown
Contributor

This PR addresses the redistribution of FAQ content into the corresponding doc sections (#39).

Changes introduced:

  1. Deleted FAQ file (docs/explanation/faq.md) and its index reference (docs/explanation/index.md)
  2. Sections (slice_definitions_format_package) and (slice_definitions_format_archive) in file docs/reference/chisel-releases/slice-definitions.md edited.
  3. Section (chisel_yaml_format_spec_archives) in file docs/reference/chisel-releases/chisel.yaml.md edited.
  4. File docs/explanation/mode-of-operation.md edited
  5. File docs/reference/chisel-releases/index.md edited

Signed-off-by: barbaravalera <barbara.valeramuros@canonical.com>
Signed-off-by: barbaravalera <barbara.valeramuros@canonical.com>
Clarified that PPAs are not supported for package fetching.

Signed-off-by: barbaravalera <barbara.valeramuros@canonical.com>
Clarify package name requirements and archive definitions.

Signed-off-by: barbaravalera <barbara.valeramuros@canonical.com>
Signed-off-by: barbaravalera <barbara.valeramuros@canonical.com>
Added a link to create a new issue for missing releases.

Signed-off-by: barbaravalera <barbara.valeramuros@canonical.com>
Updated the link for creating a new issue in the chisel-releases repository.

Signed-off-by: barbaravalera <barbara.valeramuros@canonical.com>
Signed-off-by: barbaravalera <barbara.valeramuros@canonical.com>
Fix formatting and clarify package versioning behavior.

Signed-off-by: barbaravalera <barbara.valeramuros@canonical.com>
Signed-off-by: barbaravalera <barbara.valeramuros@canonical.com>
Fixed formatting issues in the documentation.

Signed-off-by: barbaravalera <barbara.valeramuros@canonical.com>
@barbaravalera
Copy link
Copy Markdown
Contributor Author

Hi @asanvaq, redistribution of the content has been done. However, there is a connection error with https://packages.ubuntu.com/ that causes the link check to fail.

@asanvaq asanvaq self-requested a review May 19, 2026 12:19
Copy link
Copy Markdown
Contributor

@asanvaq asanvaq left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution! I have left a few suggestions.

Comment thread docs/reference/chisel-releases/chisel.yaml.md Outdated
Comment thread docs/reference/chisel-releases/slice-definitions.md Outdated
Comment thread docs/reference/chisel-releases/slice-definitions.md Outdated
barbaravalera and others added 3 commits May 21, 2026 11:34
Co-authored-by: Anna Sancho Vaquer <anna.sanchovaquer@canonical.com>
Signed-off-by: barbaravalera <barbara.valeramuros@canonical.com>
Co-authored-by: Anna Sancho Vaquer <anna.sanchovaquer@canonical.com>
Signed-off-by: barbaravalera <barbara.valeramuros@canonical.com>
Co-authored-by: Anna Sancho Vaquer <anna.sanchovaquer@canonical.com>
Signed-off-by: barbaravalera <barbara.valeramuros@canonical.com>
@barbaravalera
Copy link
Copy Markdown
Contributor Author

Hi @asanvaq, thank you for your review and suggestions. I've included them.

Comment thread docs/reference/chisel-releases/slice-definitions.md
Signed-off-by: barbaravalera <barbara.valeramuros@canonical.com>
Copy link
Copy Markdown
Contributor

@asanvaq asanvaq left a comment

Choose a reason for hiding this comment

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

Thanks! It all looks good to me now.

Small comment, for future contributions, please make sure your commits follow the Conventional Commits v1.0.0 guidelines. This also applies to the PR title. It should start with "docs: FAQ...". Could you update the title to follow this format please?

@asanvaq
Copy link
Copy Markdown
Contributor

asanvaq commented May 21, 2026

Pinging @cjdcordeiro for a second review.

@asanvaq asanvaq requested a review from cjdcordeiro May 21, 2026 09:53
@barbaravalera barbaravalera changed the title fixes: FAQ content needs redistribution #39 docs: redistribute FAQ content into relevant sections (fix to issue #39) May 21, 2026
@asanvaq asanvaq merged commit e5fb3b7 into canonical:main May 22, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants