nikcio opened a new pull request, #958:
URL: https://github.com/apache/lucenenet/pull/958

   This is a leg more on the fix @paulirwin have been trying out for solving 
#911 
   
   This is based on the commits @paulirwin made here: 
https://github.com/paulirwin/lucene.net/tree/issue/911
   
   Use this to finish off the what is left to have docfx fully working.
   
   ## What did I add?
   
   1. Replaced `toc.yml`
   As mentioned 
[here](https://github.com/apache/lucenenet/issues/793#issuecomment-2349070692) 
there was a problem with the `toc.yml` being locked this was fixed by changing 
the path to `"./toc.yml"` instead of `toc.yml"`.
   
   
![luc-1](https://github.com/user-attachments/assets/3019453e-bdab-48e9-a546-1064fa347e83)
   
   2. Added small delay when building site output.
   
   While the first fix solved the problem I noticed in one case when running 
locally that the file got locked anyway therefore I added a 1 second delay 
between starting new site out builds and haven't seen the error since.
   
   3. Fixed the links to the assets (`js` and `css`)
   
   When starting the docs site locally the pages weren't showing the CSS or 
using the js files because the route was wrong due to the missing `_rel` 
variable, therefore, I've added a slash `/` before all uses of these files so 
it works locally and removed the ending slash from the 
`docfx.global.subsite.json`.
   
   `docfx.vendor.css` was also changed to `docfx.vendor`.min.css`.
   `docfx.vendor.js` was also changed to `docfx.vendor.min.js`
   
   4. Added an environment variable replacement postprocessor
   
   I'm not sure if it works in all cases that it should but I've created a 
`EnvironmentVariableProcessor` that makes sure to replace 
`EnvVar:ENVIRONMENT_VARIABLE` to the actual value of the environment variable. 
As far as I could tell this is only used on the index page but I have no idea 
if this is correct. I haven't replaced the other plugin modules in these 
changes so that is still missing.
   
   
![image](https://github.com/user-attachments/assets/d11e7395-bca2-4e16-a486-9ddba7d12ae3)
   
   ## Next step
   
   @paulirwin or @Shazwazza feel free to take these changes and finish them off 
😄 
   
   I think the only thing missing is the remaining commented out plugin files 
otherwise it looks to be working.
   
   ## How I've been testing
   
   I've used the following command to test it.
   
   ```sh
   ./websites/apidocs/docs.ps1 -ServeDocs -LuceneNetVersion 4.8.0-beta00016 
-BaseUrl http://localhost:8080
   ```


-- 
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.

To unsubscribe, e-mail: [email protected]

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

Reply via email to