#680 Move docs to a separate repo
Closed: fixed 3 years ago by jflory7. Opened 4 years ago by asamalik.

The Fedora Docs consumes sources from this repository to build the (Fedora Badges Docs)[https://docs.fedoraproject.org/en-US/badges/]. However, this repo is relatively huge and pulling it significantly slows down the whole build.

Could we please move the docs to a separate repo so it's faster to pull?


Metadata Update from @bex:
- Custom field artwork adjusted to None
- Custom field concept_review_passed adjusted to None

4 years ago

I can do this. Is there a preferred deadline for this @asamalik?

Metadata Update from @jflory7:
- Custom field triaged adjusted to on
- Issue assigned to jflory7
- Issue tagged with: type - docs

4 years ago

@jflory7 Thanks! I don't have a date, the sooner the better, but it doesn't really block anything.

It's just I've been doing a lot of testing with the docs recently and there was quite a but of waiting involved, so fixing it will make it much smoother for me and others in the future. :-)

BTW to not break production docs build, let's do this in multiple steps:

  1. copy the docs to a separate repo
  2. I'll then switch the repo in the build script
  3. remove the docs from this repo

... so everything keeps working. Please let me know when I can do the switch. Thanks again!

As a side note, should the tooling handle cases like this eventually?

  • do shallow clones
  • do sparse checkouts

kind remember, if you could please do this action
you repo is cloned about 40 times per day because of docs automation
it's a giant waste of resources

let me know if I may help

Okay, I will dedicate sometime to do the migration this week.

If you just tell me where you want your docs to be, I can open the required pull requests to help you.
Would https://pagure.io/fedora-badges-docs be fine for you?

@jibecfed Sorry for the delay. I bootstrapped a new repo here:

https://pagure.io/fedora-badges/docs

If you could help us move the docs content over and get the publishing hooks updated, that would be great! I gave you commit access on that new repository.

i will do it, but what is the publishing hook you refer to?

fedora docs have the address of you repo and a branch, it automatically pu=
blishes what is in the branch, there is no hooks I'm aware of=2E

I mean however the docs get built from the AsciiDoc source in git into the generated HTML on docs.fp.o.

Metadata Update from @jflory7:
- Issue assigned to jibecfed (was: jflory7)

3 years ago

Both related PRs (fedora-badges#755 and fedora-docs/docs-fp-o#141) are merged. The changes should be noticeable in another 1-2 hours in production. Please follow-up in this ticket if any additional follow-up work is needed.

Thanks @jibecfed! :tada:

Metadata Update from @jflory7:
- Issue close_status updated to: fixed
- Issue status updated to: Closed (was: Open)

3 years ago

Login to comment on this ticket.

Metadata
Related Pull Requests
  • #755 Merged 3 years ago