From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id 589E01FF380 for ; Fri, 19 Apr 2024 13:21:18 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 0E82F7250; Fri, 19 Apr 2024 13:21:19 +0200 (CEST) Date: Fri, 19 Apr 2024 13:20:45 +0200 From: Christoph Heiss To: Aaron Lauterer Message-ID: <4yyxhlnirazjxpzjkbzdhxoci6rna2oou7fwd5rqikloxnsuqa@nyga22gy3vai> References: <20240419090519.291775-1-c.heiss@proxmox.com> <20240419090519.291775-2-c.heiss@proxmox.com> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: X-SPAM-LEVEL: Spam detection results: 0 AWL -0.396 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_ASCII_DIVIDERS 0.8 Email that uses ascii formatting dividers and possible spam tricks KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: Re: [pve-devel] [RFC PATCH docs-common 01/13] installation-media: move page from pve-docs here X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox VE development discussion Cc: Proxmox VE development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pve-devel-bounces@lists.proxmox.com Sender: "pve-devel" Thanks for the review! On Fri, Apr 19, 2024 at 12:51:07PM +0200, Aaron Lauterer wrote: > > > On 2024-04-19 11:05, Christoph Heiss wrote: > > Small adaptions were necessary; mostly a s/{pve}/{product}/g and > > replacing the ISO URL with the {iso-url} variable. > > except there are still plenty of `{pve}`s in there? Oh right, that is a leftover from splitting the patch into to separate commits. I'll remove that with the next revision. Sorry for the confusion. > > another thing looking at this patch, how do we handle product specifics? > having a ton of variables that are set according to the product, might be > cumbersome. > > Most likely something like `ifdef:product-pve` and so forth would be useful. Depending on the amount of specifics, that's were splitting sections out into partials (into proxmox-docs-common) and then including them into the main page (in the product-specific docs) come into play. E.g. the installer page is a good example where I tried to apply this pattern. Some things like the installer flow and advanced options are sharable, there are still some sections that are specific to e.g. PVE. As for e.g. the `{pve}` macro, there is now simply a `{product}` (and `{product-short}` macro, which already handles most other, trivial differences. But overall, that is definitely a point to discuss further and improve upon incrementally as pages/sections are moved and pain points are discovered, IMO. > > some situations I spotted where we would probably need it in this patched > marked below: All of these should be fixed up/adapted in the next patch in the series. I've split them into two for review sake, where the first is a 1:1 copy and the next patch then adapts it. [..] > > + > > +ifdef::wiki[] > > +Boot your Server from the USB Flash Drive > > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > > + > > +Connect the USB flash drive to your server and make sure that booting from USB > > +is enabled (check your servers firmware settings). Then follow the steps in the > > +xref:chapter_installation[installation wizard]. > > Aligning chapter references will also be some work, especially if we want to > keep old direct links still working. That's a very good point, thanks for noticing! I'll definitely keep note of that, but probably would deal with that as we come to that. > > > + > > +endif::wiki[] > > -- > > 2.44.0 > > > > > > > > _______________________________________________ > > pve-devel mailing list > > pve-devel@lists.proxmox.com > > https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel > > > > _______________________________________________ pve-devel mailing list pve-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel