spacebar/kamal
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added a comment to the front matter of the configuration docs about the generator

Browse Source
This commit is contained in:
Dmytro Shteflyuk
2024-09-29 14:17:05 -04:00
parent 994a8faf6b
commit 7ea995db91
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
bin/docs
View File

@@ -30,6 +30,7 @@ DOCS = {
"ssh" => "SSH", "ssh" => "SSH",
"sshkit" => "SSHKit" "sshkit" => "SSHKit"
} }
DOCS_PATH = "lib/kamal/configuration/docs"
class DocWriter class DocWriter
attr_reader :from_file, :to_file, :key, :heading, :body, :output, :in_yaml attr_reader :from_file, :to_file, :key, :heading, :body, :output, :in_yaml
@@ -94,6 +95,8 @@ class DocWriter
def generate_header def generate_header
output.puts "---" output.puts "---"
output.puts "# This file has been generated from the Kamal source, do not edit directly."
output.puts "# Find the source of this file at #{DOCS_PATH}/#{key}.yml in the Kamal repository."
output.puts "title: #{heading[2..-1]}" output.puts "title: #{heading[2..-1]}"
output.puts "---" output.puts "---"
output.puts output.puts
@@ -131,7 +134,7 @@ class DocWriter
end end
end end
from_dir = File.join(File.dirname(__FILE__), "../lib/kamal/configuration/docs") from_dir = File.join(File.dirname(__FILE__), "../#{DOCS_PATH}")
to_dir = File.join(kamal_site_repo, "docs/configuration") to_dir = File.join(kamal_site_repo, "docs/configuration")
Dir.glob("#{from_dir}/*") do |from_file| Dir.glob("#{from_dir}/*") do |from_file|
DocWriter.new(from_file, to_dir).write DocWriter.new(from_file, to_dir).write