Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Check markdown links #1090

Merged
merged 1 commit into from
Jun 5, 2020
Merged

Check markdown links #1090

merged 1 commit into from
Jun 5, 2020

Conversation

tiziano88
Copy link
Collaborator

I tried a few tools out there, but liche was the only one that
actually checks links between docs in the same repository.

Checklist

  • Pull request affects core Oak functionality (e.g. runtime, SDK, ABI)
    • I have written tests that cover the code changes.
    • I have checked that these tests are run by Cloudbuild
    • I have updated documentation accordingly.
    • I have raised an issue to
      cover any TODOs and/or unfinished work.
  • Pull request includes prototype/experimental work that is under
    construction.

@tiziano88 tiziano88 requested a review from jul-sh June 5, 2020 00:46
daviddrysdale
daviddrysdale approved these changes Jun 5, 2020
View reviewed changes
docs/concepts.md Outdated
@@ -1,7 +1,7 @@
# Oak Concepts

- [Oak Runtime](#oak-runtime)
- [Oak Node](#oak-node)
- [Oak Node](#nodes)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you make the text in-sync too ([Nodes](#nodes)) please?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

scripts/check_formatting Outdated
@@ -82,6 +82,19 @@ find . \
\( -type f -name '*.md' \) \
\) -exec markdownlint {} +

# We exclude the following URLs from the checks:
# - https://groups.google.com/g/project-oak-discuss : not publicly accessible
# - https://crates.io/crates : returns 404
Copy link
Contributor

@daviddrysdale daviddrysdale Jun 5, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice to check crates.io links too. I guess this is down to rust-lang/crates.io#788, so is there maybe some option to get liche to include Accept: text/html ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created raviqqe/liche#39 to track.

@tiziano88
Check markdown links
39f972c 
I tried a few tools out there, but `liche` was the only one that
actually checks links between docs in the same repository.
jul-sh
jul-sh approved these changes Jun 5, 2020
View reviewed changes
Copy link
Contributor

@jul-sh jul-sh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh that's nice :)

@tiziano88 tiziano88 merged commit 0a2077d into project-oak:master Jun 5, 2020
@tiziano88 tiziano88 deleted the tzn_link_check branch June 5, 2020 09:30
@github-actions
Copy link

github-actions bot commented Jun 5, 2020

Reproducibility Index:

a4f0e2702ee556e9b80f27310ebab538fea665013df8b1fe6ea4d1d5d3150e9c  ./examples/target/wasm32-unknown-unknown/release/abitest_0_frontend.wasm
8af1773838548948d265b1ed5ab76494a4f2e9a652d6a0673647eee5e4e22f15  ./examples/target/wasm32-unknown-unknown/release/abitest_1_backend.wasm
5408c4bc285e800006ae9308d911be9ae3c4fc79a1f2def3be77c164965b8603  ./examples/target/wasm32-unknown-unknown/release/aggregator.wasm
770a3aa5fda1d6a0cf8d5dd7b79d0a7833ffb8a211a9d47edbdefa11584e7f2d  ./examples/target/wasm32-unknown-unknown/release/chat.wasm
8d2e6574d6f8e160dd5f4ad0251f5596553540952c07cf9dec2bec808cacd0bb  ./examples/target/wasm32-unknown-unknown/release/hello_world.wasm
d17eccca566b8727f9505a2291b4dc52c493597b42e63be44f242315f934c6c3  ./examples/target/wasm32-unknown-unknown/release/machine_learning.wasm
8003aae7f63a45baef27a0f60ce7db250ce847fd570197cce58f5ec255e9c7d2  ./examples/target/wasm32-unknown-unknown/release/private_set_intersection.wasm
8db49d8532c1bdae9c212fcfa2cc81b492ed4a36dac6c5d30669220421595e2a  ./examples/target/wasm32-unknown-unknown/release/running_average.wasm
abc62fb1edd35f0d51d4cbe666c13024be4920a7f9138c1b49d8652c5fc0bafd  ./examples/target/wasm32-unknown-unknown/release/translator.wasm
dd30b817662ecbcaff4ac1207d7b5317062ac9b6b9c8547bb1f7dceefcac1ba9  ./examples/target/wasm32-unknown-unknown/release/trusted_information_retrieval.wasm
bb1c2f869a9095976073598a86e3da8d322d92a1b35faf0063f69009b4942dd3  ./target/x86_64-unknown-linux-musl/release/oak_loader

Reproducibility Index diff:


      		
    

  





        


            

            

              
            

        

      


      

            
  

    
  
    
    

  

  



    












      

  
          

  

    
  


  

      

    @daviddrysdale
daviddrysdale



    mentioned this pull request
    
      Jun 5, 2020
    





  


  

      
  
  Closed

  







  




  

  

    
  


  

    


      @tiziano88
tiziano88



        linked an issue
        Jun 5, 2020
        that may be
        closed
        by this pull request





  

    
      Add deadlink check for docs in CI
      #1055
  



  

      
  
  Closed

  







  













  
  

    

      

  




    


    

      

              

  
    Sign up for free
    to join this conversation on GitHub.
    Already have an account?
    Sign in to comment


  



      

    

  




  
    




      

  

    
    

    
  

    Reviewers
  


    


        

          

  
      @daviddrysdale
  
    daviddrysdale



          
            
              
            
          
          daviddrysdale approved these changes

        

        

          

  
      @jul-sh
  
    jul-sh



          
            
              
            
          
          jul-sh approved these changes

        


      






    

  


      
  

    Assignees
  



        

    No one assigned







      


  


  

    Labels
  



    

      

    cla: yes









      

  

    

        

    Projects
  


        




    None yet




  



      


  

    
  

    Milestone
  


      No milestone





    
      
          
  

    

      

        
          

            
    

    Development
  



              


Successfully merging this pull request may close these issues.


  
    
            
        Add deadlink check for docs in CI


  


        
      

    

  


      

    

  
      

  

    

      4 participants
    

    

        
          @tiziano88 
        
          @daviddrysdale 
        
          @jul-sh 
        
          @googlebot