Skip to content

Conversation

@maiska
Copy link

@maiska maiska commented Jul 7, 2020

No description provided.

@marmarek
Copy link
Owner

Can documentation index be in qubes-doc repo?

@marmarek
Copy link
Owner

I was planning to rebase pages rework (mostly html -> md) to be before adding language switch, to merge it early (and avoid conflicts due to page changes in the meantime). But looking at what pages are affected, I think it doesn't make much sense (the chance of such changes is low, and even then resolving the conflict should be easy here).

@marmarek
Copy link
Owner

@andrewdavidwong here is the current state of website translation preparation. Can you take a look at layout/formatting changes? Many pages were converted to a proper md + layout format instead of direct html pages.

PS Commits "author" field is to be fixed, and also properly rebased on master branch. But it shouldn't affect review that much.

@andrewdavidwong
Copy link

andrewdavidwong commented Jul 19, 2020

Erm, sorry if this is a dumb question, but how do I get the contents of this PR onto my local machine so I can review the layout/formatting changes?

I tried using the archive rendered site provided by @maiska via email, but it looks rather broken compared to the way serving the site locally via Jekyll usually looks.

@maiska
Copy link
Author

maiska commented Jul 22, 2020

Hello Andrew (@andrewdavidwong),
it will be best if you checked my repositories locally and build this on you local machine.
That would be master of https://github.com/maiska/qubesos.github.io.testrun & https://github.com/maiska/qubes-doc.testrun.
Currently there are further changes going on though (several md files containing html and the html is going into includes/layouts)
I hope I can be ready this week, since there are alltogether 18 (9 md files & includes/layouts needing tweeking) , 4 of them already done.
Also after that I would like to merge the current master of qubes-os in the above test repos to reflect the current changes, and see how bad it is with the 1000 changes :)

@andrewdavidwong
Copy link

Thanks, @maiska! So far, the layout and formatting looks pretty good. Just a couple minor things:

  • Should the language switcher button itself be giving me more options than just EN right now?
  • I suggest increasing the padding around the language switcher button so that it is easier to click and more evenly spaced compared to other buttons on the navbar.

Comment on lines 99 to 105
- snippet: This is a
url: /doc/testing/
- snippet: testing release
- snippet: Please help us improve it by
url: /doc/reporting-bugs/
- snippet: reporting any bugs you encounter.
- snippet: For important work, we recommend the latest stable release.

Choose a reason for hiding this comment

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

This looks kind of scary. What's going on with these snippets?

Copy link
Author

@maiska maiska Oct 23, 2020

Choose a reason for hiding this comment

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

Now I see your comment, sorry I wasn't checking github emails :) Yeah, the thing with the snippets. I am not happy about it either. Why: because converted all translatable files to md, by either extracting html into includes or layouts & their respective strings into data files. (Why no html: transifex can break html things) The snippets are consequences of this, in order to preserve the original layout and not introduce any more changes. But it is a start and once we figure out if downloads.html (f.ex.) can be just written with markdown or other tricks like including html directly into the markdown file, I can easily make the change :)

@marmarek marmarek changed the base branch from translation to master November 5, 2020 17:18
marmarek and others added 21 commits July 10, 2021 23:48
_doc:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object e89bc971aef5db137c055737a10a77cf9fe646b7
    type commit
    tag adw_e89bc971
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1625953646 -0700

    Tag for commit e89bc971aef5db137c055737a10a77cf9fe646b7

    e89bc971 Update terminology
"Qubes documentation" and varaints are redundant with the large
"Documentation" page heading above, and this more clearly states the
nature of this page.

A minor problem introduced by this change is that it might be confusing
to have both "Page contents" in the sidebar as well as "Table of
contents" here, but attentive readers should be able to tell that "Page
contents" refers to the contents of this page, where as "Table of
contents" refers to the contents of the documentation as a whole. At any
rate, this still seems like the lesser of two evils compared to "Qubes
documentation" (and variants).
_doc:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object 6eea2bf39456647a2ecbdde5344a213b7aad3c31
    type commit
    tag adw_6eea2bf3
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1625954639 -0700

    Tag for commit 6eea2bf39456647a2ecbdde5344a213b7aad3c31

    6eea2bf3 Fix typo
- Add that instructions were tested on a Fedora 33 qube
- Move info about Podman in Debian above instructions
- Update heading syntax
- Wrap text
Removes AnchorJS anchors from the team page, since the anchors cause
elements to be misaligned (off-center) on small screens. They were
removed previously but were accidentally reintroduced during the recent
layout consolidation.

Minor: Also standardizes some nearby source code formatting.
_hcl:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object bee80aee99fb7298ce27f2dd4fedb25e02ae0a4f
    type commit
    tag adw_bee80aee
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1626284669 -0700

    Tag for commit bee80aee99fb7298ce27f2dd4fedb25e02ae0a4f

    bee80ae Merge branch 'SvenSemmler-2021-07-13_new_HCLs'
    3e13d10 add Lenovo ThinkPad X13 Yoga Gen2 by Tie-fighter from 7/13/21
_doc:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object 392c994914e6b05cf4b34a5b53bb08ca4395c41d
    type commit
    tag adw_392c9949
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1626284776 -0700

    Tag for commit 392c994914e6b05cf4b34a5b53bb08ca4395c41d

    392c9949 Merge branch 'dksmiffs-master'
    4ff73993 Copyedit
    13f79972 Fix link to HTML syntax (#1174)
    40557873 Add clarification based on PR #1174 feedback
    d4d00ef9 Merge tag 'adw_6eea2bf3'
    cc8155ff Undo change to 'Copying the ISO' header, not worth the broken links
    64b1015e Reduce Windows confusion in renamed 'Installation medium preparation' section
_doc:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object db5654974877c59c6f441e2e83c903d29c98f7cc
    type commit
    tag adw_db565497
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1626286995 -0700

    Tag for commit db5654974877c59c6f441e2e83c903d29c98f7cc

    db565497 Move files back to qubes-doc so they can appear in index
    7d894a59 Update filename to match new title
    c001d213 Update title to distinguish from main HCL page
I'm still not sure why these files have to be in qubes-doc in order to
appear in the doc index, but they do, so I'm moving them back even
though they're mostly empty.
Oddly enough, this typo didn't seem to have any effect on the visual
style guide page.
Since the anchor link portion of the URL begins with a '#', these were
being interpreted as comments in hcl.yml. This commit simply quotes the
values so that they can be used to generate functional anchor links.
_hcl:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object 4d1cff50502c9d271a7591882fd3b41563f09729
    type commit
    tag adw_4d1cff50
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1626467628 -0700

    Tag for commit 4d1cff50502c9d271a7591882fd3b41563f09729

    4d1cff5 Merge branch 'SvenSemmler-2021-07-14_new_HCLs'
    6abcd81 correcting chipset-short to Sandy Bridge EP
    89ab2f3 add Lenovo ThinkStation D30 by ark from 7/14/21
_posts:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object 95c19554ee78ba901dc560fcfa6458ccd50caab6
    type commit
    tag adw_95c19554
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1626467808 -0700

    Tag for commit 95c19554ee78ba901dc560fcfa6458ccd50caab6

    95c1955 Merge branch 'dksmiffs-master'
    d5e45ee Fix htmlproofer errors in recent qubes-doc PRs eleven76 & eleven77...
_doc:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object 4de71b367d210747c9643813638866bdd659b308
    type commit
    tag adw_4de71b36
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1626467853 -0700

    Tag for commit 4de71b367d210747c9643813638866bdd659b308

    4de71b36 Merge branch 'dksmiffs-master'
    d01ad9c3 Fix htmlproofer errors in PRs #1176 & #1177...
_hcl:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object 0785a2ba3c7f76d618a6da87776c12a34ecb95ee
    type commit
    tag adw_0785a2ba
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1626659286 -0700

    Tag for commit 0785a2ba3c7f76d618a6da87776c12a34ecb95ee

    0785a2b Merge branch 'SvenSemmler-2021-07-17_new_HCLs'
    236b244 update model number, RAM and kernel version as requested by Del on 7/17/21
_doc:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object 649babd88c6459d74cf1a0768e258f960ddb56ae
    type commit
    tag adw_649babd8
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1626716125 -0700

    Tag for commit 649babd88c6459d74cf1a0768e258f960ddb56ae

    649babd8 Merge branch 'dksmiffs-master'
    9bb30e22 Resolve grammatical error, return to "this verification" wording (#1179)
    c917f907 Fix lost referent on "this verification" (#1179)
    a0b355b0 Move 'properly validated keys' guidance before git verification...
marmarek and others added 30 commits December 8, 2021 22:22
_posts:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object 862233e3de9e4a2b28d938b3958503000e3e24e1
    type commit
    tag adw_862233e3
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1638998498 -0800

    Tag for commit 862233e3de9e4a2b28d938b3958503000e3e24e1

    862233e Merge branch 'mfc-patch-4'
    0a85c8f fix fedora typo
_posts:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object bb31ec3915dd20acac7f62d8f720b5ddbfe1f665
    type commit
    tag adw_bb31ec39
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1639000157 -0800

    Tag for commit bb31ec3915dd20acac7f62d8f720b5ddbfe1f665

    bb31ec3 Update forum URL
_posts:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object ddac2b7b8e976649b9295d32c2273f2e99e8e62f
    type commit
    tag adw_ddac2b7b
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1639000750 -0800

    Tag for commit ddac2b7b8e976649b9295d32c2273f2e99e8e62f

    ddac2b7 Add note about 4.1 release candidates
_doc:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object 6f7f5786043bb97dd43095e36fdf345acf80852a
    type commit
    tag adw_6f7f5786
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1639254950 -0800

    Tag for commit 6f7f5786043bb97dd43095e36fdf345acf80852a

    6f7f5786 Merge branch 'smoothie-on-the-rocks-patch-2'
    50488bfc Change inline commands to block for easy selection
_posts:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object 17056ca82cef4756b8dd696c6eec7c3a649fd5df
    type commit
    tag adw_17056ca8
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1639446219 -0800

    Tag for commit 17056ca82cef4756b8dd696c6eec7c3a649fd5df

    17056ca Security: Canary 029
_posts:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object 92c2ffc276512b9fe1113365aab4f0b9e70b17ca
    type commit
    tag adw_92c2ffc2
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1639446309 -0800

    Tag for commit 92c2ffc276512b9fe1113365aab4f0b9e70b17ca

    92c2ffc Remove unnecessary heading
_doc:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object dc5746473face5d00805d716db70f9c02cfe3586
    type commit
    tag adw_dc574647
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1639448270 -0800

    Tag for commit dc5746473face5d00805d716db70f9c02cfe3586

    dc574647 Update URLs
_hcl:

    8b7c28f add Lenovo ThinkPad P15 Gen2 by @ewokky from 12/19/21
_posts:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object cf5c6f2fa5b9ea7023271d296ec7131330ca85a5
    type commit
    tag adw_cf5c6f2f
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1640063001 -0800

    Tag for commit cf5c6f2fa5b9ea7023271d296ec7131330ca85a5

    cf5c6f2 Security: XSAs released on 2021-12-20
_posts:
    gpg: Good signature from "Marek Marczykowski-Górecki (Qubes Documentation Signing Key) <marmarek@invisiblethingslab.com>" [ultimate]
    object b265f91a0e3562d7ad5f271da457a4ddc0605ff6
    type commit
    tag mm_b265f91a
    tagger Marek Marczykowski-Górecki <marmarek@invisiblethingslab.com> 1640096779 +0100

    Tag for commit b265f91a0e3562d7ad5f271da457a4ddc0605ff6

    b265f91 Update 4.1.0-rc3 date
    30d34c0 Merge remote-tracking branch 'origin/pr/93'
    6152dac Add punctuation
    41af0c9 Release: Qubes 4.1-rc3
_posts:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object 3daf27fa060b0ab21ec14844c4984d0ff168ae70
    type commit
    tag adw_3daf27fa
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1640164871 -0800

    Tag for commit 3daf27fa060b0ab21ec14844c4984d0ff168ae70

    3daf27f Fix typo
_doc:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object e7e21d47b901b7cdac8f4f8eeab080e3f0ee8659
    type commit
    tag adw_e7e21d47
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1640166185 -0800

    Tag for commit e7e21d47b901b7cdac8f4f8eeab080e3f0ee8659

    e7e21d47 Merge branch 'deeplow-patch-28'
    b221d40f Merge branch 'patch-28' of github.com:deeplow/qubes-doc into deeplow-patch-28
    ee9057a7 Merge branch 'smoothie-on-the-rocks-patch-1'
    b9c6de6f Merge branch 'patch-1' of github.com:smoothie-on-the-rocks/qubes-doc into smoothie-on-the-rocks-patch-1
    900656fc note possibility to add rpc services in app qube
    e724e60c Add fedora details to convert VM to Qube section
_hcl:

    bc4ae23 add Cirrus7 Incus (AMD X300) by @kurt from 12/23/21
    6a6df91 add Lenovo ThinkPad T480s by @HowardPlayzOA from 12/22/21
_hcl:

    6531ece add ASRock X570 Pro4 by @qubes85156 from 12/25/21
_hcl:

    6807bc4 add Dell XPS 13 9305 by @M4Us from 12/26/21
_hcl:

    2c3d3f5 add Dell Precision 7540 by @drwelander from 12/29/21
_hcl:

    a9410a0 user requested name change
attachment:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object 7d6ee40abb6cecd975b267d32f2153bd8f62d6a8
    type commit
    tag adw_7d6ee40a
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1640943838 -0800

    Tag for commit 7d6ee40abb6cecd975b267d32f2153bd8f62d6a8

    7d6ee40 Merge branch 'deeplow-openqa-investigator-image'
    aa56a1e add example image for openqa_investigator script
attachment:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object f3927d6cb44d010e665a833fe22ac1ab6e5c5c89
    type commit
    tag adw_f3927d6c
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1640944022 -0800

    Tag for commit f3927d6cb44d010e665a833fe22ac1ab6e5c5c89

    f3927d6 Move image to appropriate subdirectory
_doc:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object 8f4fced9a8d1ce2d1d897c2aa8170e3622c3d190
    type commit
    tag adw_8f4fced9
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1641179051 -0800

    Tag for commit 8f4fced9a8d1ce2d1d897c2aa8170e3622c3d190

    8f4fced9 Merge branch 'deeplow-openqa-update'
    ba6d93a0 Fix typo
    7e8ea7b0 add documentation for openqa_investigator script
_hcl:

    82c37a8 add Dell Precision M4800 by IX4 Svs from 12/30/21
_doc:
    gpg: Good signature from "Marek Marczykowski-Górecki (Qubes Documentation Signing Key) <marmarek@invisiblethingslab.com>" [ultimate]
    object 9f309c198be6d7934032f10c7b1e0a963601d6a4
    type commit
    tag mm_9f309c19
    tagger Marek Marczykowski-Górecki <marmarek@invisiblethingslab.com> 1641525534 +0100

    Tag for commit 9f309c198be6d7934032f10c7b1e0a963601d6a4

    9f309c19 Update R4.1 release schedule
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.

7 participants