Re: HIG migration

--===============0278160073236267712==
Content-Type: multipart/alternative; boundary="000000000000a8405805bec1c4f6"

--000000000000a8405805bec1c4f6
Content-Type: text/plain; charset="UTF-8"

On Tue, Mar 30, 2021 at 2:26 AM Allan Day <[email protected]> wrote:

> Sriram Ramkrishna <[email protected]> wrote:
> ...
> > I"m seeing more of this going forward - migration to gitlab pages. This
> is great - but at some point we'll need to figure out how all this fits
> together coherently.
>
> Good question.
>
>
We have a current GSoD proposal that will look at auditing the
wiki.gnome.org and then work on a proposal for documentation for GNOME for
the dynamic content although not the api docs.

There are puzzles to deal with it - for instance we've found that many get
started working on GNOME code through extensions and do it without proper
content.

> I assume you will update the developer.gnome.org web pages and any other
> housekeeping or is that going to be up to engagement/docs teams? Don't want
> to assume :)
>
> My impression from reading Emmanuele's blog [1] is that the current
> incarnation of developer.gnome.org (ie. based on library-web) is going
> away, and that API docs will be generated using Sphinx in the future.
>

Fair enough - but I assume there must be some pointer that will need to be
added. But if you migrate before the above happens then we should probably
update the links.

IMHO we should sunset developer.gnome.org as quickly as possible as it is
full of GNOME3/GTK3 isms.


> The design team is likely to use something Sphinx-like, with a
> customised theme. That theme could be used by other GNOME projects to
> give our docs a consistent look. We could also potentially investigate
> common navigation elements, like a home button that takes you to
> developer.gnome.org.
>

We also need to integrate https://gjs.guide/ which is another entry point
into the GNOME developer-verse.



> Regarding developer.gnome.org itself, I think we could potentially do
> a new static home page which links off to each of the independent
> Sphinx-generated docs sites. This would need to be manually updated to
> add new content, but that's probably a good thing.
>

That makes sense to me.

Best,
sri



> Allan
> --
> [1] https://www.bassi.io/articles/2021/03/17/more-documentation-changes/
>

--000000000000a8405805bec1c4f6
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr"><div dir=3D"ltr"><br></div><br><div class=3D"gmail_quote">=
<div dir=3D"ltr" class=3D"gmail_attr">On Tue, Mar 30, 2021 at 2:26 AM Allan=
 Day &lt;<a href=3D"mailto:[email protected]">[email protected]</a>&gt; wrote:<br=
></div><blockquote class=3D"gmail_quote" style=3D"margin:0px 0px 0px 0.8ex;=
border-left:1px solid rgb(204,204,204);padding-left:1ex">Sriram Ramkrishna =
&lt;<a href=3D"mailto:[email protected]" target=3D"_blank">[email protected]=
e</a>&gt; wrote:<br>
...<br>
&gt; I&quot;m seeing more of this going forward - migration to gitlab pages=
. This is great - but at some point we&#39;ll need to figure out how all th=
is fits together coherently.<br>
<br>
Good question.<br>
<br></blockquote><div><br></div><div>We have a current GSoD proposal that w=
ill look at auditing the <a href=3D"http://wiki.gnome.org">wiki.gnome.org</=
a> and then work on a proposal for documentation for GNOME for the dynamic =
content although not the api docs.</div><div><br></div><div>There are puzzl=
es to deal with it - for instance we&#39;ve found that many get started wor=
king on GNOME code through extensions and do it without proper content.<br>=
</div><div><br></div><blockquote class=3D"gmail_quote" style=3D"margin:0px =
0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
&gt; I assume you will update the <a href=3D"http://developer.gnome.org" re=
l=3D"noreferrer" target=3D"_blank">developer.gnome.org</a> web pages and an=
y other housekeeping or is that going to be up to engagement/docs teams? Do=
n&#39;t want to assume :)<br>
<br>
My impression from reading Emmanuele&#39;s blog [1] is that the current<br>
incarnation of <a href=3D"http://developer.gnome.org" rel=3D"noreferrer" ta=
rget=3D"_blank">developer.gnome.org</a> (ie. based on library-web) is going=
<br>
away, and that API docs will be generated using Sphinx in the future.<br></=
blockquote><div><br></div><div>Fair enough - but I assume there must be som=
e pointer that will need to be added. But if you migrate before the above h=
appens then we should probably update the links.</div><div><br> </div><div>=
IMHO we should sunset <a href=3D"http://developer.gnome.org">developer.gnom=
e.org</a> as quickly as possible as it is full of GNOME3/GTK3 isms.</div><d=
iv><br></div><blockquote class=3D"gmail_quote" style=3D"margin:0px 0px 0px =
0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
The design team is likely to use something Sphinx-like, with a<br>
customised theme. That theme could be used by other GNOME projects to<br>
give our docs a consistent look. We could also potentially investigate<br>
common navigation elements, like a home button that takes you to<br>
<a href=3D"http://developer.gnome.org" rel=3D"noreferrer" target=3D"_blank"=
>developer.gnome.org</a>.<br></blockquote><div><br></div><div>We also need =
to integrate <a href=3D"https://gjs.guide/">https://gjs.guide/</a> which is=
 another entry point into the GNOME developer-verse.</div><div><br></div><d=
iv> <br></div><blockquote class=3D"gmail_quote" style=3D"margin:0px 0px 0px=
 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
Regarding <a href=3D"http://developer.gnome.org" rel=3D"noreferrer" target=
=3D"_blank">developer.gnome.org</a> itself, I think we could potentially do=
<br>
a new static home page which links off to each of the independent<br>
Sphinx-generated docs sites. This would need to be manually updated to<br>
add new content, but that&#39;s probably a good thing.<br></blockquote><div=
><br></div><div>That makes sense to me.</div><div><br></div><div>Best,</div=
><div>sri<br></div><div><br></div><div> <br></div><blockquote class=3D"gmai=
l_quote" style=3D"margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,20=
4,204);padding-left:1ex">
<br>
Allan<br>
-- <br>
[1] <a href=3D"https://www.bassi.io/articles/2021/03/17/more-documentation-=
changes/" rel=3D"noreferrer" target=3D"_blank">https://www.bassi.io/article=
s/2021/03/17/more-documentation-changes/</a><br>
</blockquote></div></div>

--000000000000a8405805bec1c4f6--

--===============0278160073236267712==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

_______________________________________________
gnome-doc-list mailing list
[email protected]
https://mail.gnome.org/mailman/listinfo/gnome-doc-list

--===============0278160073236267712==--