The repo that hosts the site is https://github.com/apache/lucenenet-site/ which
is the compiled output of the site and the docs which is a compiled static
html site compiled with docfx.

The main repo https://github.com/apache/lucenenet
<https://github.com/apache/lucenenet-site/> has the site and docs source
for building the static file output using docfx. Whenever we publish the
site, the github action we've made compiles the site from the main repo
using docfx which produces a static file output which is pushed as a PR to
the lucenenet-site repo. These files are then used by Apache's infra to
host those files in the asf-site branch (see
https://infra.apache.org/project-site.html#sitemanagement ... the
information here is vague unfortunately but that's how it works in our case)

Since the static site is always hosted based on the files in the asf-site
branch, you could create a root folder there
https://github.com/apache/lucenenet-site/tree/asf-site and then just
reference images based on the docfx source like
"/site-images/my-image.jpg". Those images will then be pulled to apache
infra's hosting services and then we aren't using GitHub to host/serve the
images which would prob be better.

Does that make sense?



On Tue, May 18, 2021 at 5:12 PM Ron Clabo - Git <[email protected]>
wrote:

> Thanks Shannon,
>
> I appreciate the quick response.  I guess I'm a little confused.  I
> thought the website lived in the main repo at
> https://github.com/apache/lucenenet/tree/master/websites/site  and I
> wasn't previously aware of https://github.com/apache/lucenenet-site/
>
> Using a branch in https://github.com/apache/lucenenet-site/ called images
> could work great.  Or even a folder called site-images on the main branch
> there.
>
> What's the difference between
> https://github.com/apache/lucenenet/tree/master/websites/site   and
> https://github.com/apache/lucenenet-site/ ?  How is the one used vs the
> other?
>
> -Ron
>
>
> -----Original Message-----
> From: Shannon Deminick [mailto:[email protected]]
> Sent: Tuesday, May 18, 2021 6:48 PM
> To: [email protected]
> Subject: Re: Good place to store LuceneNet website images?
>
> Hi Ron,
>
> What about storing them in the docs repo directly? The site's branch is
> this one https://github.com/apache/lucenenet-site/tree/asf-site but what
> if
> we created a branch called "images" or something like that? and then you
> can references them using the raw.githubusercontent.com domain, for
> example
> this is an image in the "master" branch as a raw image that can be
> referenced in html/markdown:
>
> https://raw.githubusercontent.com/apache/lucenenet-site/master/logo/lucene-net-color.png
>
> Alternatively, another repo could work too
>
> What do you think?
>
> Shannon
>
>
> On Tue, May 18, 2021 at 3:37 PM Ron Clabo - Git <[email protected]>
> wrote:
>
> > Hey Shannon (Shazwazza) and anyone else with a good idea for solving
> this,
> >
> >
> >
> > I could use some advice.  NightOwl888 and I just revisited the process of
> > how to setup a dev box for running Eclipse in a VM on windows with the
> > ability to debug Java Lucene 4.8.  He supplied the knowhow, and I got it
> > going on my machine and document the process, taking lots of screenshots
> > along the way.
> >
> >
> >
> > So now I have this word doc with notes and 83 screenshots.  Yah, I know,
> > kinda long.  There are more than a few steps J
> >
> >
> >
> > Shad wants me to turn it all into a markdown doc for the website's
> > contributors sections.  Seems easy enough.  The challenge is the images.
> > We
> > don't really want them in the main repo since it increases the size of
> the
> > repo and time it takes to clone.
> >
> >
> >
> > So do you have a good suggestion of where I could put them?
> >
> >
> >
> > One thought was to create a sister repo for such artifacts and have the
> > markdown doc in the main repo reference the images in the sister repo.
> Such
> > a repo could be LuceneNetArtifacts for example.  We could also use it for
> > other large items related to Lucene (e.g. test text) that isn't code.
> >
> >
> >
> > But I wanted to reach out to you and the Lucene Dev community at large in
> > case you or someone else has a better idea?
> >
> >
> >
> > Thoughts?
> >
> >
> >
> > Thanks,
> >
> >
> >
> > -Ron
> >
> > rclabo
> >
> >
>
>
>
>

Reply via email to