NightOwl888 commented on issue #447:
URL: https://github.com/apache/lucenenet/issues/447#issuecomment-805245974


   @rclabo
   
   The [documentation for building the website and API docs 
sites](https://lucenenet.apache.org/contributing/documentation.html) gives some 
info about how all of this works, but it would be great for someone to poke 
holes in that documentation to see how well it holds up to scrutiny.
   
   1. Updates to the website happen in the pre-build stage in this repo. See 
[apidocs](https://github.com/apache/lucenenet/tree/921ad114b43f5e0cd565c54fb88667fa027d6708/websites/apidocs)
 and 
[site](https://github.com/apache/lucenenet/tree/921ad114b43f5e0cd565c54fb88667fa027d6708/websites/site).
   2. The documentation is then "assembled" using the DocFx build engine.
   3. The main/API sites are then updated by copying and pasting the files into 
https://github.com/apache/lucenenet-site/, which is setup to serve the site 
live.
   
   The build process serves the site up on your localhost so you can preview it 
as you make changes.
   
   @Shazwazza has been working on getting more of this process automated (like 
setting it up so accepting a PR automatically builds/deploys the site), but we 
are not quite there yet.
   
   > NOTE: It would be great if we could come up with a way to be able to 
"preview" pages more quickly than to go through the drawn out build process, if 
it is possible. Consider that a feature request.
   
   > NOTE: I am currently updating that document because we have switched over 
to using mini-sites for the API docs, which each have their own DocFx 
configuration file and the document still only mentions the common 
configuration file that we used when there was one site.
   
    


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to