1. 28 1月, 2021 2 次提交
  2. 15 1月, 2021 2 次提交
    • A
      Update katacoda playground to latest releases · 38594c8b
      Alan Greene 提交于
      Update the Katacoda tutorial playground to the latest available releases:
      - Pipelines 0.20
      - Dashboard 0.13
      - CLI 0.15
      38594c8b
    • A
      Update Dashboard tutorial to latest versions · eb4a406e
      Alan Greene 提交于
      Update the Dashboard katacoda tutorial to use the latest releases:
      - Dashboard 0.13.0
      - Pipelines 0.20.0
      
      Update screenshots to reflect the new design in recent dashboard versions.
      While doing this I converted the images to JPEG for significant filesize
      savings over the existing PNG images (>50% on average)
      eb4a406e
  3. 27 11月, 2020 1 次提交
  4. 26 11月, 2020 1 次提交
  5. 24 11月, 2020 1 次提交
  6. 13 11月, 2020 1 次提交
  7. 12 11月, 2020 1 次提交
  8. 11 11月, 2020 1 次提交
  9. 09 11月, 2020 3 次提交
    • A
      Fix the case of non-md files in nested folders · a5ed52e7
      Andrea Frittoli 提交于
      In case of non-md files in nested folders, the filename used in the
      rewrite included the target path leading to double-path in the link.
      Fixed that and added a use case for the non-md file in a subfolder.
      Signed-off-by: NAndrea Frittoli <andrea.frittoli@gmail.com>
      a5ed52e7
    • A
      Switch sync config from files to folders · 85a5bcb6
      Andrea Frittoli 提交于
      Change the sync configuration from files to folders, so make the
      configuration easier to maintain as well to allow syncing folders
      of generated docs, where the list of files may vary and for which
      it is not possible to pre-add the YAML headers used by docsy.
      
      This change implies the following modification to the sync process:
      - we do not download files one-by-one to disk and rewrite them to
        a different location on disk. Instead we git clone all relevant
        repositories, and pull files at the correct reference into the
        site content folder direcly
      - we now support pulling content from different folders in the
        tekton repos. As part of the configuration a target folder in
        the website can be specified. The default is '/'.
        This will allow pulling in content from other folders that may
        not even be under `docs`.
      
      As part of the re-work, a couple of issues have been fixed:
      - links to the index page were re-written to github because the
        `_index.md` could not be found locally in the source. This case
        is now handled by the code
      - links to files in nested folders were re-written to github
        because the files were downloaded to the parent folders and
        thus not found locally. Files configured from a nested folder
        are now downloaded to the configured target folder and the
        check has been fixed.
        In one case this issue had the side effect of fixing the broken
        link in content/en/vault/Triggers-v0.7.0/exposing-eventlisteners.md:
        - [`create-ingress`](./create-ingress.yaml)
        the YAML file is not in the `docs` folder so the link should be:
        - [`create-ingress`](./getting-started/create-ingress.yaml)
        which would have to be fixed on triggers side, with a new minor
        release.
      
      Overall the execution time ("real") has been improved (real), at
      least on my laptop. The "user" time is bit more so on systems
      with fewer CPU cores it may take slightly longer.
      
      - before:
      real	0m41.870s
      user	1m52.244s
      sys	0m29.440s
      
      - after, no cache:
      real	0m31.981s
      user	2m25.869s
      sys	0m46.176s
      
      - after, with cache:
      real	0m21.382s
      user	2m24.826s
      sys	0m42.637s
      
      Added more unit test coverage (75% now).
      To verify this change I also diffed the content generated before
      this change with the content generated after the change.
      Signed-off-by: NAndrea Frittoli <andrea.frittoli@gmail.com>
      85a5bcb6
    • A
      Finetune .gitignore · 004f9e04
      Andrea Frittoli 提交于
      Instead of ignoring the whole content folder, only ignore folders
      that we sync. Add a few more ignore files for python and IDEs.
      Signed-off-by: NAndrea Frittoli <andrea.frittoli@gmail.com>
      004f9e04
  10. 07 11月, 2020 1 次提交
  11. 06 11月, 2020 1 次提交
  12. 05 11月, 2020 1 次提交
    • A
      Add a nightly deployment for the website · 428238c3
      Andrea Frittoli 提交于
      Use a simple scheduled github action to deploy
      the website nightly. The deploy step includes sync,
      so this will pull in an up to date version of the docs
      on the master branch.
      428238c3
  13. 31 10月, 2020 2 次提交
  14. 29 10月, 2020 3 次提交
  15. 27 10月, 2020 1 次提交
    • A
      Rewrite the link re-writing logic · c09354a6
      Andrea Frittoli 提交于
      The previous logic parses URLs with a regex first and then using
      the markdown library. It then uses urlopen().read() to validate
      links.
      
      We use now the markdown library only to extract the list of links,
      and then urlparse to deconstruct, analyse, adapt and reconstract
      the link. We do not attempt to fetch links anymore, which means
      that external links are not guaranteed to be working.
      
      Absolute URLs are not changed (they may be external)
      Fragments are relative to the page and do not need changes
      Path only links should point to a file synced to the website
      but sometimes the file may be missing (if it's not in the sync
      configuration), so we follow this approach:
      - prefix with base_path and check for the file locally
      - if not found, prefix with base_url instead
      
      Note that urlparse treats URLs without scheme like path only
      URLs, so 'github.com' will be rewritten to base_url/github.com
      Signed-off-by: NAndrea Frittoli <andrea.frittoli@gmail.com>
      c09354a6
  16. 23 10月, 2020 2 次提交
  17. 21 10月, 2020 2 次提交
    • A
      Further cleanup the sync script · c93169a9
      Andrea Frittoli 提交于
      Cleanup typos, simplify logic in a few places.
      Make the list of files config a dict instead of a list of dicts.
      Signed-off-by: NAndrea Frittoli <andrea.frittoli@gmail.com>
      c93169a9
    • P
      refactor sync script · c4894b3a
      popcor255 提交于
      As a developer, it is difficult to make changes to a script and ensure that nothing is broken without tests. Test are added in this patch with 80% code coverage. The script has also been refactored to increase readability. This refactor is not a pure refactor. The sync did not work properly. There is a list of bugs that reported the script generating broken links, #160, #126, #158, #133, #134. This refactor also includes a patch that fixes these bugs. The patch redirects a user to github if there is a relative link to a file that does not exist. This is important because some links will reference a snippet of code, test, or example. These artifacts are not docs, they are not rendered properly on the site. It is better to redirect the user to the intended artifact if the file is not synced. This prevents random 404s, and preserves the original behavior of the sync script. There are other approaches to fix this bug. This includes, manually editing links, downloading the files that the broken link are referencing in the sync config file, or removing the broken links. This is the best approach because broken links are automatically fixed and do not require manual intervention. This approach causes a side effect of not requiring the config file to be up-to date because the script will redirect the user to github. We want to encourage frequent sync. So eventually, this script should become tekton-ified (tekton task) and placed into the tekton catalog repo. Sync needs to become a tekon task in order for every repo to sync docs on push event.
      c4894b3a
  18. 10 10月, 2020 2 次提交
  19. 22 9月, 2020 1 次提交
    • P
      remove modal from interactive tutorials · f2d525e0
      popcor255 提交于
      The modal in the interactive tutorials is difficult to navigate. I can not scroll (left to right) and (up and down) because of the embedded iframe.
      f2d525e0
  20. 10 9月, 2020 1 次提交
  21. 03 9月, 2020 1 次提交
  22. 02 9月, 2020 1 次提交
  23. 20 8月, 2020 1 次提交
    • A
      Update Katacoda scenarios to Kubernetes 1.18 · abe688ec
      Alan Greene 提交于
      Update all Katacoda scenarios to run on Kubernetes 1.18, with
      a 2 node cluster.
      
      Fix some issues in the tasks and runs scenarios that seem to have
      been undone in rebases before they were merged.
      
      Update the Dashboard scenario to run the latest Pipeline and
      Dashboard versions at time of writing.
      
      Remove the use of the ingress in the Dashboard scenario since
      it appears unstable on Katacoda with kubernetes 1.18. Using a
      port-forward is sufficient for this scenario.
      abe688ec
  24. 12 8月, 2020 1 次提交
    • A
      Add Katacoda playground · 648a2291
      Alan Greene 提交于
      Add a Katacoda scenario that can act as a playground for users
      to experiment with Tekton in a sandbox environment.
      
      This environment provides a 2-node Kubernetes cluster with the
      following projects installed:
      - Pipelines v0.14.3
      - Dashboard v0.8.2
      - CLI v0.11.0
      
      Typical startup time is <1minute, but may take 2 or 3 minutes
      in some cases. The installation should not require any manual
      steps by the user.
      648a2291
  25. 31 7月, 2020 1 次提交
  26. 29 7月, 2020 1 次提交
    • A
      Update image URLs in dashboard Katacoda tutorial · 682190cf
      Alan Greene 提交于
      Katacoda supports linking to images in the assets folder. Update our
      existing links to use this approach instead of using the GitHub 'raw'
      URLs as this gives us greater portability for the tutorials and ensures
      the correct version of the images is loaded even if we stop loading content
      from the `master` branch in future.
      682190cf
  27. 21 7月, 2020 2 次提交
  28. 20 7月, 2020 1 次提交
  29. 27 6月, 2020 1 次提交