Re: Using branch names instead of branched yaml files for building docs.fp.o?

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Le 21 août 2020 00:28:16 GMT+03:00, Ben Cotton <bcotton@xxxxxxxxxx> a écrit :
>Hi docs team,
>
>mattdm recently suggested we should rename the default branch of
>council-docs from "master" to something else[1]. I suggested "prod"
>because I have ulterior motives.
>
>Right now, we have separate branches for building the production and
>staging docs.fp.o. This makes staging useful for testing changes to
>the build system itself, but not for content. Granted, people can (and
>should) test content changes locally before pushing, but for changes
>that span across repos or for sharing rendered changes with someone
>else for review, that becomes more challenging.
>
>Would it be possible to configure things such that docs.stg.fp.o build
>from the repos' 'stg' branches and the main docs sites build from the
>'prod' branches? This way, every docs repo that gets included by
>Antora can have stage and production content for "free". Then, for
>example, if I made a big structural change to the Council docs, I
>could do that on the stage branch so that it would be built and
>visible to anyone I wanted to share it with, but the production
>content would be untouched until we were ready to merge.
>
>Would it be as simple as changing line 6 on site.yml to be 'prod' on
>the prod branch and 'stg' on the stage branch? (Or better, could we
>pull it from some environment variable/file/whatever?)
>
>Assuming this is both technically possible and also desirable, would
>it be possible to have the production docs site support both "master"
>and "prod" as branch names to provide a migration window. Or would we
>have to migrate to this model by updating the site.yml on a per-repo
>basis?
>
>[1] https://pagure.io/Fedora-Council/council-docs/issue/86
>[2] https://pagure.io/fedora-docs/docs-fp-o/blob/prod/f/site.yml#_6

Hello, doing it is easy, "by updating the site.yml on a per-repo basis". The one on docs-fp-o

As far as I know, changing the default branch isn't possible.

For local testing, having two yaml files makes it easier for user to understand what they see.

In addition, this change have no impact on localization system.
--
Jean-Baptiste
_______________________________________________
docs mailing list -- docs@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to docs-leave@xxxxxxxxxxxxxxxxxxxxxxx
Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: https://lists.fedoraproject.org/archives/list/docs@xxxxxxxxxxxxxxxxxxxxxxx




[Index of Archives]     [Fedora Users]     [Fedora Desktop]     [Red Hat 9]     [Yosemite News]     [KDE Users]

  Powered by Linux