#61 [TRACKER TICKET] Porting Diversity wiki pages to Fedora Docs
Closed: Complete 5 years ago Opened 6 years ago by jflory7.

The Diversity Team needs to port important information from our wiki pages to Fedora Docs. This ticket is to help consolidate the important information we need to port and to plan our actions.

For an example, see some of the CommOps docs that are published. Source files are available in the fedora-commops repo.


Well, for some reason I can't take this ticket for me, but I will work on this between this week and next one.

@x3mboy Let me know if you need help with this.

Please, I'm only part time at least for one more week, and I can't do this as fast as I like to do it.

We can discuss in the meeting how we can coordinate these wiki pages will be ported.

I recommend we move this task to the backlog until May.

I think it's okay if this is a lower priority task for now. There is a technical issue with the docs for sub-projects and how the deployment system works. This prevents sub-projects from having "final" URLs. We are having the same problem with the CommOps docs right now.

@bex estimated another month before this technical issue is resolved. We can begin migrating wiki content into the docs now, but then we have content sitting in our repo for a while that cannot be published yet.

Once the tooling issue is resolved, this can become a higher priority. For now, there isn't a "good" place for the Diversity docs to go yet.

Metadata Update from @jflory7:
- Issue priority set to: by next release cycle (was: normal (3-4 weeks))
- Issue set to the milestone: Fedora 29 (to Oct. 2018) (was: Fedora 28 (to May 2018))

6 years ago

Metadata Update from @bee2502:
- Issue tagged with: meeting

6 years ago

Metadata Update from @bee2502:
- Issue untagged with: meeting
- Issue tagged with: blocked

6 years ago

I recommend we move this task to the backlog until May.

@jflory7 hey , are we still blocked on this one or the issue is resolved?

I think it's okay if this is a lower priority task for now. There is a technical issue with the docs for sub-projects and how the deployment system works. This prevents sub-projects from having "final" URLs. We are having the same problem with the CommOps docs right now.
@bex estimated another month before this technical issue is resolved. We can begin migrating wiki content into the docs now, but then we have content sitting in our repo for a while that cannot be published yet.
Once the tooling issue is resolved, this can become a higher priority. For now, there isn't a "good" place for the Diversity docs to go yet.

@amsharma wrote…
@jflory7 hey , are we still blocked on this one or the issue is resolved?

This one is still blocked. The external ticket is docs-fp-o#77 – I think @asamalik and @bex are actively working on this. Once that ticket is closed, it will prevent us from being in a similar situation to docs-fp-o#69, which has prevented the CommOps team from fully moving off of the wiki.

I anticipate Flock being a good time to try and unblock this. @rkratky proposed a docs hackfest at Flock (flock#85) and I hope to attend this session. I would like to work on getting the D&I Team fully integrated into the docs site. This could also be a good opportunity for us to sit in on the session and be on the same page about how we maintain and update our pages in the future.

But for now… still blocked. 'til Flock. :mount_fuji:

Yes, we're working on switching the docs to use Antora as a backend. https://pagure.io/fedora-docs/docs-fp-o/issue/77

The staging site has been already built using Antora: https://docs.stg.fedoraproject.org/

What we could do is to start porting the wiki pages to the staging site. I'm happy to help you get started. I'll be also preparing some materials (i.e. a basic repository structure, guidelines, etc.) for everyone to use.

My goal is to have the new site out before Flock.

@asamalik said…
What we could do is to start porting the wiki pages to the staging site. I'm happy to help you get started. I'll be also preparing some materials (i.e. a basic repository structure, guidelines, etc.) for everyone to use.

@asamalik Has anything in the process changed since the Docs FAD? If not, it's something I can try to set up and prepare before then, so we can spend less time at Flock doing menial work. If it hasn't changed, I will probably copy from the fedora-commops repo.

If it has, could you give a recommendation on what the best way to do things are now?

See this template repo created by @asamalik for current best practices.

Depending on @bex's response to this mailing list thread with regards to #54, I could try to do the groundwork for this over the weekend.

Metadata Update from @jflory7:
- Issue assigned to jflory7

5 years ago

Metadata Update from @jflory7:
- Issue untagged with: blocked
- Issue priority set to: urgent (1-2 weeks) (was: by next release cycle)

5 years ago

PR #77 adds an Antora configuration and set up. Upstream ticket docs-fp-o#90 requests the Fedora Docs team to review the PR and set up the infrastructure for the site.

Our goal is to have published documentation within the next week, if possible. This will replace the wiki pages.

Metadata Update from @jflory7:
- Issue priority set to: waiting on assignee (was: next meeting)

5 years ago

Thanks to @asamalik, the D&I Team now publishes documentation at docs.fedoraproject.org/en-US/diversity-inclusion/.

Our pages we publish are now saved to this Pagure repository. Edits are made to the files here to make changes to the content we are publishing. Changes are made via pull requests. All doc files are written in AsciiDoc.

For now, two pages were migrated off of the wiki and into docs:

More pages will be moved in the future.

I am closing this ticket as complete. :clapper: Thanks for the help of @asamalik @bex @pbokoc @ryanlerch and other Docs Team members for making this easy!

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

5 years ago

Login to comment on this ticket.

Metadata