On 05/28/2015 08:27 AM, Pete Travis wrote:
On 05/27/2015 08:57 AM, Adam Samalik wrote:
Hello everyone!
I would like to make a proposal about new project: a website for Fedora developers.
=== Why? ===
- Fedora does not have a page targeted on developers like developer.ubuntu.com or developer.apple.com
- Developers have no place to find out about interesting projects like Copr, Developer Assistant, etc.
- There is also no place with guides and help on how to get things up and running
- Current fedoraproject wiki is not designed for app developers, 'developers' on wiki essentially means Fedora packagers
- There is no place for downloading (promoting) Docker images and Vagrant boxes based on Fedora
=== What? ===
Create a new page: developer.fedoraproject.org - a new go-to place for app developers running Fedora.
The web page has would show beginners or advanced users how to install a new features on Fedora and what to do if they want to start developing something in Fedora.
The main categories could be something like these:
1. Development tools:
- Vagrant, Developer Assistant, ...
- Which tools to use for development and how they can help me
- explain WHAT the project is and HOW to get it running
2. Languages, technologies, runtimnes:
- Python, Ruby, Rails, Perl, ...
- Info about packages, the "I am a _ developer" view
- explain WHAT the project is and HOW to get it running
3. Distribution/deployment:
- Copr, Docker, Openshift, ...
- How to get my project to people?
- explain WHAT the project is and HOW to get it running
4. Docker images, Vagrant boxes, ...
5. Blogs
Petr Hracek and Josef Stribny and I are starting this project and I will be the one responsible for it.
Do you have any tips, recommendations or expectations about this project? Is there something you would like to see on the page? Let's start a discussion!
Thanks!
Adam Samalik
Associate Software Engineer
Red Hat
This sounds a lot like developer-focused documentation. The docs team
has been talking a lot about refocusing lately, and I had it in mind to
structure something that would provide appropriate content to users,
contributors, community members, and developers. It would be great if
we could combine efforts on this.
Hi Pete,
you are right. it is developer-focused documentation which could
be actualized based of top projects which are developed within Fedora.
Do you have any content already which was done by docs team?
Current top projects are I think Docker, Vagrant, DevAssistant.
There's a rough concept in place that I've been *slowly* hacking at;
take a bunch of git repos containing source markup (ie one for each
current guide, one for the python SIG, one with fedora-infra SOPs, one
for the Server WG and edition, you get the idea) and process them. One
step validates and pushes strings to zanata for translation; another
renders to html and extracts some metadata, another step parses the
metadata to create a menu / site structure. The steps are run by
buildbot (maybe taskotron, eventually) and triggered by commits or
fedmsg signals, so content creators can simply write out a
ReStructuredText article without getting concerned about the publishing
process and presentation.
This is what I missed in my first proposal. Translation to different
languages
can really be important for people which are not quite good in English.
Like me;)
We've found that more people are willing to write - whether it's API
reference materials or general desktop usage - if their domain knowledge
can be the focus, and not documentation tooling and processes.
I think it can be a separate page like documentation.fedoraproject.org.
API is a different issue.
I htink that it can be covered and handled by developer.fedoraproject.org
but developers which maintain API should also take care about the page.
My first draft was create a template for fedoraproject.org for rest
pages which will be developed in future.
Personally I think that current wiki [1] is not useless or not
readability for beginners and advanced developers.
We also
find that a git workflow enables better quality documentation and
fosters a sense of ownership and involvement, so the idea is to meet
halfway.
Nowadays we have a GitHub repository [2] which does not contain any
contents.
Our idea is to use mechanishm like Jekyll and pages will be actualized
by pull-request.
[1] https://fedoraproject.org/wiki/Fedora_Project_Wiki
[2] https://github.com/phracek/developer-fedoraproject-org
--
Petr Hracek
Software Engineer
Developer Experience
Red Hat, Inc
Mob: +420777056169
email: phracek@xxxxxxxxxx
--
websites mailing list
websites@xxxxxxxxxxxxxxxxxxxxxxx
https://admin.fedoraproject.org/mailman/listinfo/websites
