Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f4702fe066 | ||
|
|
fea8dbef1a | ||
|
|
6a527d36a8 | ||
|
|
2292f472c9 | ||
|
|
2aaaeee5a7 | ||
|
|
ca161690da | ||
|
|
8bd1a71065 | ||
|
|
eb72fdc717 | ||
|
|
a7f819a78e | ||
|
|
d4d58e166b | ||
|
|
1d41a198cb | ||
|
|
6ced9d03d3 | ||
|
|
19c7616a4b | ||
|
|
a82281ad1c | ||
|
|
f3e1f9df90 | ||
|
|
c85b9e8cbc | ||
|
|
ece0475808 | ||
|
|
2e0bb9304a | ||
|
|
74c0142968 | ||
|
|
7c71d90d17 | ||
|
|
f86fde81e6 | ||
|
|
43814450e5 | ||
|
|
d5077ee816 | ||
|
|
2cf2c6979e | ||
|
|
154fe0d447 | ||
|
|
a493f0117d | ||
|
|
cc0400bdd4 | ||
|
|
8b57a035ee | ||
|
|
dc57f83d19 | ||
|
|
611f556cf9 | ||
|
|
d06ad04341 | ||
|
|
72c89268ec | ||
|
|
3f99b483cb | ||
|
|
9bef235252 | ||
|
|
18935dcfdd | ||
|
|
db2fb81654 | ||
|
|
6fbd4878be | ||
|
|
023a9905f6 | ||
|
|
6facdac464 | ||
|
|
377600d0a3 | ||
|
|
b6cf078395 | ||
|
|
673ca25cf2 | ||
|
|
4038f0384b | ||
|
|
f5dc6ab994 | ||
|
|
aa45703a99 | ||
|
|
f01de5c802 | ||
|
|
827b64d633 | ||
|
|
7bf82c7ea9 | ||
|
|
3055a3ada0 | ||
|
|
5b1883802e | ||
|
|
bef677678b | ||
|
|
61c59b514f | ||
|
|
8f998e799d | ||
|
|
c2f455ec1b | ||
|
|
3a8af97eb9 | ||
|
|
e6c13057ce | ||
|
|
5f47a25711 | ||
|
|
4c9b67ead4 | ||
|
|
adef5e0e6a | ||
|
|
4e2632e100 | ||
|
|
4ff204a0c4 | ||
|
|
1e0baf5f6c | ||
|
|
a9c56e5bb2 | ||
|
|
4a1fc11b2d | ||
|
|
42c22a7bbb | ||
|
|
369537e515 | ||
|
|
3880279e89 | ||
|
|
524e7bcfd3 | ||
|
|
3bac1d2d9d | ||
|
|
d7ac0ee17a | ||
|
|
462b7d861d | ||
|
|
f523f8b2e3 | ||
|
|
279b009882 | ||
|
|
ee4feb17c4 | ||
|
|
2a014e56b0 | ||
|
|
040763ebb2 | ||
|
|
dfd8d340a0 | ||
|
|
ca6bc12cfc | ||
|
|
5b4bf5964e | ||
|
|
f72bfd8f3a | ||
|
|
0d93c109fb | ||
|
|
1cd8f4d4f7 | ||
|
|
25acd7fd16 | ||
|
|
3e6dae9616 | ||
|
|
1dce070245 | ||
|
|
cc552d9777 | ||
|
|
c7d448ca49 | ||
|
|
fe0bd3ff67 | ||
|
|
b5adc2bf93 | ||
|
|
6f9bad3d05 | ||
|
|
f28799cc4c | ||
|
|
e2376c27b4 | ||
|
|
e4a0aa3480 | ||
|
|
045a365a1b | ||
|
|
1059e9873a | ||
|
|
e0522cc20e | ||
|
|
ef83d4314e | ||
|
|
3b4ca09931 | ||
|
|
19adf0cd7e | ||
|
|
3fb1fdf16a | ||
|
|
695b0759e4 | ||
|
|
6dbdf4d88b | ||
|
|
e55430f61a | ||
|
|
a68f3edcd4 | ||
|
|
e438df87fa | ||
|
|
bb9f4136f5 | ||
|
|
aaf9f18d93 | ||
|
|
2f23120a64 | ||
|
|
7743583f4d | ||
|
|
fe5542845e | ||
|
|
e65bfcdacf | ||
|
|
9d199c86c5 | ||
|
|
fca0a60e5b | ||
|
|
6e3c42f238 | ||
|
|
ab94b68571 | ||
|
|
0662a44017 | ||
|
|
78e530f506 | ||
|
|
ab0b43d51c | ||
|
|
d975534bf7 | ||
|
|
ec22e22bbd | ||
|
|
0face3e966 | ||
|
|
823aacdeba | ||
|
|
c605d1d2c6 | ||
|
|
ef65602b79 | ||
|
|
778f047376 | ||
|
|
2b805fc7ca | ||
|
|
f3fe3123b3 | ||
|
|
c1ac7fcd38 | ||
|
|
7e7d9720be | ||
|
|
4fbaae4b12 | ||
|
|
07b294778a | ||
|
|
8c0a368969 | ||
|
|
99c2020795 | ||
|
|
54b384efec | ||
|
|
975286c2ac | ||
|
|
70b01eb9c8 | ||
|
|
1755d3a017 | ||
|
|
22f385b809 | ||
|
|
f751546913 | ||
|
|
587b166a4e | ||
|
|
b208528d3d | ||
|
|
882abff431 | ||
|
|
892da2478b | ||
|
|
28f5cd7852 | ||
|
|
8e0571c7c9 | ||
|
|
d6fc9f71d0 | ||
|
|
108ef50bd5 | ||
|
|
90b7680392 | ||
|
|
a8a9831c16 | ||
|
|
a1f39bb7d3 | ||
|
|
a50c9f76ec | ||
|
|
f6e679e70e | ||
|
|
17bb1ac39f | ||
|
|
33c23c1341 | ||
|
|
9dd084810f | ||
|
|
d4e1cd4f1e | ||
|
|
aa8c27fd5d | ||
|
|
806104626f | ||
|
|
2331dffe4c | ||
|
|
2d69542265 | ||
|
|
3e8cbe112f | ||
|
|
31ff3f0290 | ||
|
|
f606c3705f | ||
|
|
758ee32aa9 | ||
|
|
163b1d0731 | ||
|
|
e732cf59e0 | ||
|
|
a571c7b72c | ||
|
|
9340e62895 | ||
|
|
efd86e1b27 | ||
|
|
f1e243c145 | ||
|
|
e867b220a1 | ||
|
|
a04c40d016 | ||
|
|
4fb1a8fbe8 | ||
|
|
b959dd2e49 | ||
|
|
5c09099084 | ||
|
|
fc5711ce7c | ||
|
|
cc14044b6b | ||
|
|
e0dc7f2f81 | ||
|
|
03ce1e27c7 | ||
|
|
735f9abef7 | ||
|
|
f2ddaa7921 | ||
|
|
75321d306a | ||
|
|
d2e9364e5e | ||
|
|
b61f994746 | ||
|
|
633593e412 | ||
|
|
e7c0ff7d41 | ||
|
|
bda974a72c | ||
|
|
dbb2b49b55 | ||
|
|
e770c619e5 | ||
|
|
0d8d07d474 | ||
|
|
dd07c68201 | ||
|
|
e9804a5b76 | ||
|
|
85c384c64a | ||
|
|
fed5fd4c5e | ||
|
|
eec35b285e | ||
|
|
e2f1f778f3 | ||
|
|
7b87d7c52c | ||
|
|
c88fe59c71 | ||
|
|
9eac1512fb | ||
|
|
8f8afaf139 | ||
|
|
e651433727 | ||
|
|
8ac7db46e0 | ||
|
|
1e8148c051 | ||
|
|
520cc0e130 | ||
|
|
2338fbb06f | ||
|
|
3687602508 | ||
|
|
49ec161c5e | ||
|
|
4923708836 | ||
|
|
11f9ef1045 | ||
|
|
bb3e6d6907 | ||
|
|
574fb55fcf | ||
|
|
b96ca0735d | ||
|
|
c421e655c5 | ||
|
|
66d4669f36 | ||
|
|
953f63c7bd | ||
|
|
fca1123ee5 | ||
|
|
5eaf11b8aa | ||
|
|
0274ceb312 | ||
|
|
38f96c7e46 | ||
|
|
7b3cc8fdf0 | ||
|
|
c184e7be65 | ||
|
|
bfbb80efcf | ||
|
|
01bdc5bf89 | ||
|
|
711d7c2c41 | ||
|
|
2b4e53e926 | ||
|
|
9401c1ee85 | ||
|
|
5c704f053b | ||
|
|
eb1f971d52 | ||
|
|
83bc5508ee | ||
|
|
d6a8734aae | ||
|
|
3ee98cd13a | ||
|
|
275da18cf6 | ||
|
|
3f3b11ffbf | ||
|
|
7f8cb69326 | ||
|
|
003c304105 | ||
|
|
763ab475f2 | ||
|
|
4b3f48b537 | ||
|
|
6301a78814 | ||
|
|
506b427124 | ||
|
|
19ae7d5ac6 | ||
|
|
47aaa85108 | ||
|
|
3067ecdee3 | ||
|
|
d9a0ee1e33 | ||
|
|
5cfc8dee5e | ||
|
|
1ad7ac2dcf | ||
|
|
86446c8879 | ||
|
|
df857e3194 | ||
|
|
ad7a3951c5 | ||
|
|
7e8e968013 | ||
|
|
e38baeec36 | ||
|
|
ca28f962d4 | ||
|
|
dfb2c073d2 | ||
|
|
51b264e8ca | ||
|
|
6d2fe08973 | ||
|
|
ccc551112b | ||
|
|
1a5537f4ba | ||
|
|
5c2f0c5f4a | ||
|
|
a66de4c601 | ||
|
|
af73d0ce1a | ||
|
|
04654ca465 | ||
|
|
af10579be9 | ||
|
|
30d24a85b5 | ||
|
|
d8b386a812 | ||
|
|
48e7a13c0f | ||
|
|
70803e37fa | ||
|
|
7a770b8627 | ||
|
|
8b0d99d65d | ||
|
|
3aca0edfcc | ||
|
|
81ece23bfe | ||
|
|
66b9dfa8e9 | ||
|
|
f8e98f9f14 | ||
|
|
b97a3c4b0a | ||
|
|
b5c8ea0e13 | ||
|
|
cf2d35291e | ||
|
|
1cda7e051b | ||
|
|
a645a1e197 | ||
|
|
d0276f1d52 | ||
|
|
4474f5f813 | ||
|
|
19e693bf52 | ||
|
|
825939c820 | ||
|
|
5a9138711b | ||
|
|
7640f1199d | ||
|
|
7b6e4318d4 | ||
|
|
fcd1bc0356 | ||
|
|
d443eb1c96 | ||
|
|
c7d0c09f01 | ||
|
|
d3d8ff6c1b | ||
|
|
6f5f6900b6 | ||
|
|
19753e07e0 | ||
|
|
1888cd2ac7 | ||
|
|
4b456db517 | ||
|
|
9272f0cb2c | ||
|
|
b9a5588ca9 | ||
|
|
93d4b88d84 | ||
|
|
b0d27ee5d2 | ||
|
|
c33f1e112e | ||
|
|
f288f0f258 | ||
|
|
e4f44ffa63 | ||
|
|
d1ed089c3e | ||
|
|
e1a64dd0c1 | ||
|
|
3b6749dce9 | ||
|
|
8f6887280c | ||
|
|
ef0a2fa340 | ||
|
|
2b616ec4e2 | ||
|
|
fe02bb1678 | ||
|
|
fc1aab2472 | ||
|
|
e22cdee5f5 | ||
|
|
698d591788 | ||
|
|
3b11ca87f1 | ||
|
|
bbaf1b0c2d | ||
|
|
a151f89eec | ||
|
|
d20dc9aa64 | ||
|
|
52b5cb0902 | ||
|
|
bc5c181fc2 | ||
|
|
fed30e1b24 | ||
|
|
22de11190c | ||
|
|
e42f81a7a1 | ||
|
|
f30e7df43d | ||
|
|
c930c69629 | ||
|
|
08b6d43ac1 | ||
|
|
53b075a315 | ||
|
|
b8311d43ce | ||
|
|
1075c5da13 | ||
|
|
59c8569190 | ||
|
|
395a8adf37 | ||
|
|
d358a29b17 | ||
|
|
e253d2a376 | ||
|
|
bfd005a295 | ||
|
|
c1a3bdd895 | ||
|
|
b18462b10b | ||
|
|
30dba5dae9 | ||
|
|
f12880fb5c | ||
|
|
c61442ee76 | ||
|
|
96ae708163 | ||
|
|
b47b3ecb70 | ||
|
|
7cdc146515 | ||
|
|
e734fa3554 | ||
|
|
71b587b58e | ||
|
|
81ae6f38fc | ||
|
|
7fbb4098a4 | ||
|
|
f8af8b91f5 | ||
|
|
b5341edec0 | ||
|
|
49d60b19f3 | ||
|
|
82a7acf408 | ||
|
|
7bd57c208a | ||
|
|
27ec605955 | ||
|
|
c94e02b302 | ||
|
|
5d2d65f05c | ||
|
|
6d3d277cb9 | ||
|
|
4d654c6fe7 | ||
|
|
ecb97db913 | ||
|
|
082c244b0b | ||
|
|
678a2c7ad8 | ||
|
|
78026ac573 | ||
|
|
4cfd459317 | ||
|
|
e481c234ee | ||
|
|
0d872020e3 | ||
|
|
62016b2f83 | ||
|
|
58811ab522 | ||
|
|
19c60d1592 | ||
|
|
cd36047660 | ||
|
|
ef8289ff73 | ||
|
|
ff47a8c1ed | ||
|
|
86b506c9b6 | ||
|
|
e762471d78 | ||
|
|
1040a0d7e9 | ||
|
|
c49377569e | ||
|
|
560aa34ce2 | ||
|
|
ee18a88664 | ||
|
|
31b8c1ee3b | ||
|
|
97b9350651 | ||
|
|
b9997b2ece | ||
|
|
9c63975497 | ||
|
|
8cafe1ebf3 | ||
|
|
4dccfcc156 | ||
|
|
7af711a48b | ||
|
|
80910562b3 | ||
|
|
88b5343775 | ||
|
|
a6e75b4da6 | ||
|
|
8fb0e9e10c | ||
|
|
747d774a3c | ||
|
|
7bbcaf2174 | ||
|
|
ac21c037d6 | ||
|
|
3b47daa8fc | ||
|
|
dff08a0a8e | ||
|
|
74ad096158 | ||
|
|
be84f9ec93 | ||
|
|
6e440f11cd | ||
|
|
655a76447e | ||
|
|
dc0fc839ed | ||
|
|
efe1209550 | ||
|
|
93c5b53b77 | ||
|
|
1beaa9ec13 | ||
|
|
6e00733f68 | ||
|
|
3bffd27c74 | ||
|
|
971a314d63 | ||
|
|
40e1689e49 | ||
|
|
fe8fa94c77 | ||
|
|
a9dd4bf81a | ||
|
|
56beac6508 | ||
|
|
b0b29da388 | ||
|
|
c1cb9603a5 | ||
|
|
58722f849a | ||
|
|
9e7dd5aa27 | ||
|
|
9d13081803 | ||
|
|
78a774cfd9 | ||
|
|
9f51f9064d | ||
|
|
b229d6e1b0 | ||
|
|
2ba66afb9f | ||
|
|
36e544b537 | ||
|
|
5ec841cf2e | ||
|
|
981bb21756 | ||
|
|
a297a67385 | ||
|
|
5445b75af9 | ||
|
|
e189ac4fc2 | ||
|
|
4bc5d49792 | ||
|
|
3860039f9a | ||
|
|
cb8605cf60 | ||
|
|
4c4bb1bc2e | ||
|
|
a3fd606197 | ||
|
|
a473335ceb | ||
|
|
93d4f2c77a | ||
|
|
1562cba420 | ||
|
|
6bab9dcbaa | ||
|
|
1d266537b0 | ||
|
|
a0e9a39511 | ||
|
|
1c5fd92ad6 | ||
|
|
d578539391 | ||
|
|
49f9944b86 | ||
|
|
c3177f9ebd | ||
|
|
1e8dfa38da | ||
|
|
897771546b | ||
|
|
4632269314 | ||
|
|
56fa8fe766 | ||
|
|
09589ea9ef | ||
|
|
69de5e03d3 | ||
|
|
f8dfc75872 | ||
|
|
a2c276e0cd | ||
|
|
84da480ff4 | ||
|
|
c88033fc0b | ||
|
|
23f3585245 | ||
|
|
9a3cc517d0 | ||
|
|
3cbb02465b | ||
|
|
47c5cee459 | ||
|
|
1a5b0ec567 | ||
|
|
664ad5f26e | ||
|
|
8015ab9a1e | ||
|
|
85c1474c60 | ||
|
|
94046eeffd | ||
|
|
1662bafb50 | ||
|
|
913888a29d | ||
|
|
24600c20c5 | ||
|
|
b7a41cbd89 | ||
|
|
adceee1be0 | ||
|
|
cdcc6fb3ab | ||
|
|
3a8b9ccd80 | ||
|
|
c496d35d12 | ||
|
|
92d66fa82b | ||
|
|
4e4c8aa14f | ||
|
|
0fc864f230 | ||
|
|
c717f182b6 | ||
|
|
f104f0b46b | ||
|
|
38b8cfaa0a | ||
|
|
49e0c3587b | ||
|
|
f8ad9c421a | ||
|
|
3358fca753 | ||
|
|
d65a0cb9dc | ||
|
|
9ec0084c8b | ||
|
|
8e6ac31e49 | ||
|
|
5d2abdd95b | ||
|
|
8b0a201f69 | ||
|
|
1806259637 | ||
|
|
6893403ba7 | ||
|
|
f24b016346 | ||
|
|
b5b689973b | ||
|
|
101e188f41 | ||
|
|
5ff875b1ac | ||
|
|
1dbb4f4fb7 | ||
|
|
68a511184f | ||
|
|
2efa255eb4 | ||
|
|
3c4fdb0659 | ||
|
|
e4746007da | ||
|
|
5e1e8f85cd | ||
|
|
273c6c002f | ||
|
|
a21dbd182c | ||
|
|
0c3d7da5c8 | ||
|
|
db5165e032 | ||
|
|
89081b087b | ||
|
|
37f37c0b8b | ||
|
|
ad4c4cd014 | ||
|
|
16efdaa25c | ||
|
|
0651291e2d | ||
|
|
914a0c48d2 | ||
|
|
c0502c7b7c | ||
|
|
6cd7c4dff0 | ||
|
|
37846a5827 | ||
|
|
04e6433d5d | ||
|
|
f9f5fe436a | ||
|
|
f68572ce78 | ||
|
|
ecd99177bb | ||
|
|
3f4eb49c2f | ||
|
|
8e6f6ffda9 | ||
|
|
85f8dcc2b2 | ||
|
|
0a135173b4 | ||
|
|
34b9be0bd3 | ||
|
|
6f2d8f5372 | ||
|
|
045ab734c6 | ||
|
|
2699aa6069 | ||
|
|
f0c0936b87 | ||
|
|
314e16a88e | ||
|
|
72faa927de | ||
|
|
19b52938c3 | ||
|
|
7cedf8d580 | ||
|
|
17cbc5baad | ||
|
|
c2bcbb06a9 | ||
|
|
152c899e8b | ||
|
|
c476f54a6c | ||
|
|
4b5ab0ad93 | ||
|
|
82af0e554a | ||
|
|
b456dec138 | ||
|
|
4a8c200c37 | ||
|
|
52b736c892 | ||
|
|
d9eee058ce | ||
|
|
3676602fa2 | ||
|
|
4f3b7de04a | ||
|
|
cdf5838420 | ||
|
|
a714983c28 | ||
|
|
b9547160b5 | ||
|
|
bfa8e6a45f | ||
|
|
9764eff05d | ||
|
|
253e44fdbe | ||
|
|
585d86448f | ||
|
|
dad7b6632e | ||
|
|
4e9e025ca4 | ||
|
|
b6ea85e353 | ||
|
|
29aabaabda | ||
|
|
394c5b13f4 | ||
|
|
0a8c6e97a6 | ||
|
|
e7f1d4564a | ||
|
|
619b390af3 | ||
|
|
1488d0ca2d | ||
|
|
dd35750482 | ||
|
|
5aeba59b75 | ||
|
|
8329ef36b3 | ||
|
|
4cc42fb216 | ||
|
|
d23b210f4e | ||
|
|
803dbd6d39 | ||
|
|
e4213f6eb6 | ||
|
|
2d2576cf2d | ||
|
|
96cbee185d | ||
|
|
9f83d70b63 | ||
|
|
7deb45bed2 | ||
|
|
12d3a04bf9 | ||
|
|
fa565b75ae | ||
|
|
437d4dc04d | ||
|
|
188138ccd8 | ||
|
|
6b49c194ca | ||
|
|
a86c9431d3 | ||
|
|
6f60f3eef8 | ||
|
|
d18777bed4 | ||
|
|
82d23b9bf8 | ||
|
|
a4f58fbf10 | ||
|
|
2dbae32f20 | ||
|
|
21b0a1d852 | ||
|
|
f8535be7da | ||
|
|
95eef49cf8 | ||
|
|
2d01382a82 | ||
|
|
d443f8b2ef | ||
|
|
dffb5cdf8b | ||
|
|
5c1d8bc90c | ||
|
|
ad28922871 | ||
|
|
9d7355cbaa | ||
|
|
74a3a54543 | ||
|
|
07ca5df8d0 | ||
|
|
e730376e3e | ||
|
|
ee61c8c333 | ||
|
|
27b74a7cf2 | ||
|
|
088e665d28 | ||
|
|
9438f3c4ec | ||
|
|
b5a906b2f4 | ||
|
|
0e40cb5f4f | ||
|
|
1a1ac49ce0 | ||
|
|
4356378301 | ||
|
|
6123873d2a | ||
|
|
9a7ffc2f5b | ||
|
|
f3857abdf5 | ||
|
|
e977c7caca | ||
|
|
f40688435d | ||
|
|
e8b2a26a3b | ||
|
|
27c3a50d23 | ||
|
|
ec495fbd1d | ||
|
|
80fadcc7b8 | ||
|
|
4b37b9ac03 | ||
|
|
16d0f6a94f | ||
|
|
cc40d1ed2e | ||
|
|
425e447e5c | ||
|
|
3707b95edb | ||
|
|
2982efebb8 | ||
|
|
14db705891 | ||
|
|
9c885ef6f5 | ||
|
|
34e8d0ee3d | ||
|
|
728979636f | ||
|
|
462db2f00c | ||
|
|
2504408803 | ||
|
|
61569d1c38 | ||
|
|
5b6582698c | ||
|
|
81f0f1df6d | ||
|
|
44be0f6859 | ||
|
|
9daf97a9ab | ||
|
|
032d1a8b9a | ||
|
|
65fd1d9fbb | ||
|
|
a35cd7f4a4 | ||
|
|
74212f1810 | ||
|
|
1ed59f0789 | ||
|
|
71d8b769d5 | ||
|
|
c863616b38 | ||
|
|
09b62e514e | ||
|
|
c705ba355e | ||
|
|
7642dcf05f | ||
|
|
58a5f1cb0b | ||
|
|
1b86c367a0 | ||
|
|
6d08e6e0bc | ||
|
|
ef7d4ae385 | ||
|
|
cf1f944069 | ||
|
|
ddff7100e9 | ||
|
|
a5bc2a6d4c | ||
|
|
952b48bd68 | ||
|
|
2ad07d68b6 | ||
|
|
8c96d9c6a0 | ||
|
|
46d9808173 | ||
|
|
2e37611da8 | ||
|
|
0057270551 | ||
|
|
7a7d15b50c | ||
|
|
202cc3cb7e | ||
|
|
a761393816 | ||
|
|
fedf6b6e5b | ||
|
|
6eec55223d | ||
|
|
940b9adabd | ||
|
|
8984e4916e | ||
|
|
c9d2757760 | ||
|
|
d846aed612 | ||
|
|
d9b5b9b8a8 | ||
|
|
9c91f00cb4 | ||
|
|
0a648d1d75 |
@@ -0,0 +1,15 @@
|
|||||||
|
ignore:
|
||||||
|
- "charts"
|
||||||
|
- "demos"
|
||||||
|
- "Documentation"
|
||||||
|
- "examples"
|
||||||
|
- "test"
|
||||||
|
- "tools"
|
||||||
|
- "pkg/apis/genclient"
|
||||||
|
coverage:
|
||||||
|
status:
|
||||||
|
project:
|
||||||
|
default:
|
||||||
|
threshold: 2
|
||||||
|
# Disable patch coverage check since we focus on project coverage.
|
||||||
|
patch: off
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
*.md
|
||||||
|
*.sh
|
||||||
|
Documentation
|
||||||
|
charts
|
||||||
|
examples
|
||||||
|
environments/*
|
||||||
|
!environments/fetcher
|
||||||
|
demos
|
||||||
|
test
|
||||||
|
Makefile
|
||||||
|
LICENSE
|
||||||
|
glide.*
|
||||||
|
.travis.yml
|
||||||
|
.gitignore
|
||||||
|
.git
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
name: Blog
|
||||||
|
about: Suggest a blog
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Create a report to help us improve
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<!-- Please answer these questions before submitting your issue. Thanks! -->
|
||||||
|
|
||||||
|
<!-- Documentation URL: https://docs.fission.io/ -->
|
||||||
|
<!-- Troubleshooting guide: https://docs.fission.io/trouble-shooting/ -->
|
||||||
|
|
||||||
|
**Fission/Kubernetes version**
|
||||||
|
|
||||||
|
<!-- If you tested with other services, for example Istio, please also provide the version of service as well. -->
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
$ fission --version
|
||||||
|
$ kubectl version
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
**Kubernetes platform (e.g. Google Kubernetes Engine)**
|
||||||
|
|
||||||
|
**Describe the bug**
|
||||||
|
<!--A clear and concise description of what the bug is.-->
|
||||||
|
|
||||||
|
**To Reproduce**
|
||||||
|
|
||||||
|
<!-- Please provide steps for reproducing the error. -->
|
||||||
|
|
||||||
|
**Expected result**
|
||||||
|
<!--A clear and concise description of what you expected to happen.-->
|
||||||
|
|
||||||
|
**Actual result**
|
||||||
|
|
||||||
|
**Screenshots/Dump file**
|
||||||
|
<!--If applicable, add screenshots/fission dump file to help explain your problem.-->
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
$ fission support dump
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
<!--Add any other context about the problem here.-->
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
name: Documentation
|
||||||
|
about: Suggest changes/addition to documentation
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Describe something that is unclear or not documented and needs a documentation update
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
name: Feature request
|
||||||
|
about: Suggest an idea for this project
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Is your feature request related to a problem? Please describe.**
|
||||||
|
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||||
|
|
||||||
|
**Describe the solution you'd like**
|
||||||
|
A clear and concise description of what you want to happen.
|
||||||
|
|
||||||
|
**Describe alternatives you've considered**
|
||||||
|
A clear and concise description of any alternative solutions or features you've considered.
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
Add any other context or screenshots about the feature request here.
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
name: Code Scanning
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
paths:
|
||||||
|
- '**.go'
|
||||||
|
- go.mod
|
||||||
|
- go.sum
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
paths:
|
||||||
|
- '**.go'
|
||||||
|
- go.mod
|
||||||
|
- go.sum
|
||||||
|
schedule:
|
||||||
|
- cron: "0 0 * * 0"
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
CodeQL-Build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Check out code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- uses: actions/cache@v2
|
||||||
|
with:
|
||||||
|
path: ~/go/pkg/mod
|
||||||
|
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
|
||||||
|
restore-keys: |
|
||||||
|
${{ runner.os }}-go-
|
||||||
|
|
||||||
|
- name: Initialize CodeQL
|
||||||
|
uses: github/codeql-action/init@v1
|
||||||
|
with:
|
||||||
|
languages: go
|
||||||
|
|
||||||
|
- name: Perform CodeQL Analysis
|
||||||
|
uses: github/codeql-action/analyze@v1
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
name: Lint and Unit tests
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
paths:
|
||||||
|
- '**.go'
|
||||||
|
- go.mod
|
||||||
|
- go.sum
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
paths:
|
||||||
|
- '**.go'
|
||||||
|
- go.mod
|
||||||
|
- go.sum
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
lint:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Set up Go 1.15
|
||||||
|
uses: actions/setup-go@v2
|
||||||
|
with:
|
||||||
|
go-version: 1.15
|
||||||
|
|
||||||
|
- name: Check out code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- uses: actions/cache@v2
|
||||||
|
with:
|
||||||
|
path: ~/go/pkg/mod
|
||||||
|
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
|
||||||
|
restore-keys: |
|
||||||
|
${{ runner.os }}-go-
|
||||||
|
|
||||||
|
- name: Verify dependencies
|
||||||
|
run: |
|
||||||
|
go mod verify
|
||||||
|
go mod download
|
||||||
|
|
||||||
|
LINT_VERSION=1.41.1
|
||||||
|
curl -fsSL https://github.com/golangci/golangci-lint/releases/download/v${LINT_VERSION}/golangci-lint-${LINT_VERSION}-linux-amd64.tar.gz | \
|
||||||
|
tar xz --strip-components 1 --wildcards \*/golangci-lint
|
||||||
|
mkdir -p bin && mv golangci-lint bin/
|
||||||
|
|
||||||
|
- name: Run checks
|
||||||
|
run: |
|
||||||
|
STATUS=0
|
||||||
|
assert-nothing-changed() {
|
||||||
|
local diff
|
||||||
|
"$@" >/dev/null || return 1
|
||||||
|
if ! diff="$(git diff -U1 --color --exit-code)"; then
|
||||||
|
printf '\e[31mError: running `\e[1m%s\e[22m` results in modifications that you must check into version control:\e[0m\n%s\n\n' "$*" "$diff" >&2
|
||||||
|
git checkout -- .
|
||||||
|
STATUS=1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
assert-nothing-changed go fmt ./...
|
||||||
|
assert-nothing-changed go mod tidy
|
||||||
|
|
||||||
|
bin/golangci-lint run --out-format=github-actions --timeout=5m || STATUS=$?
|
||||||
|
|
||||||
|
exit $STATUS
|
||||||
|
|
||||||
|
- name: Run unit tests
|
||||||
|
run: ./hack/runtests.sh
|
||||||
@@ -0,0 +1,121 @@
|
|||||||
|
name: Fission CI
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
paths:
|
||||||
|
- '**.go'
|
||||||
|
- 'charts/**'
|
||||||
|
- 'test/**'
|
||||||
|
- go.mod
|
||||||
|
- go.sum
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
paths:
|
||||||
|
- '**.go'
|
||||||
|
- 'charts/**'
|
||||||
|
- 'test/**'
|
||||||
|
- go.mod
|
||||||
|
- go.sum
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
# Job to run change detection
|
||||||
|
integration-test:
|
||||||
|
runs-on: ${{ matrix.os }}
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
kindimage : [ 'kindest/node:v1.19.11','kindest/node:v1.20.7', 'kindest/node:v1.21.2' ]
|
||||||
|
os: [ ubuntu-latest ]
|
||||||
|
steps:
|
||||||
|
- name: setup go
|
||||||
|
uses: actions/setup-go@v2.1.3
|
||||||
|
with:
|
||||||
|
go-version: "1.15.12"
|
||||||
|
|
||||||
|
- name: Checkout sources
|
||||||
|
uses: actions/checkout@v2.3.4
|
||||||
|
|
||||||
|
- name: Checkout sources
|
||||||
|
uses: actions/checkout@v2.3.4
|
||||||
|
with:
|
||||||
|
repository: fission/examples
|
||||||
|
path: examples
|
||||||
|
|
||||||
|
- uses: actions/cache@v2
|
||||||
|
with:
|
||||||
|
path: ~/go/pkg/mod
|
||||||
|
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
|
||||||
|
restore-keys: |
|
||||||
|
${{ runner.os }}-go-
|
||||||
|
|
||||||
|
- name: Helm installation
|
||||||
|
uses: Azure/setup-helm@v1
|
||||||
|
with:
|
||||||
|
version: v3.3.4
|
||||||
|
|
||||||
|
- name: Kind Clutser
|
||||||
|
uses: engineerd/setup-kind@v0.5.0
|
||||||
|
with:
|
||||||
|
image: ${{ matrix.kindimage }}
|
||||||
|
version: v0.11.1
|
||||||
|
config: kind.yaml
|
||||||
|
|
||||||
|
- name: Configuring and testing the Installation
|
||||||
|
run: |
|
||||||
|
kubectl cluster-info --context kind-kind
|
||||||
|
kubectl get nodes
|
||||||
|
sudo apt-get install -y apache2-utils
|
||||||
|
|
||||||
|
- name: Helm chart lint
|
||||||
|
run: |
|
||||||
|
helm lint charts/fission-all/ charts/fission-core/
|
||||||
|
|
||||||
|
- name: Helm update
|
||||||
|
run: helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
|
||||||
|
|
||||||
|
- name: Install Skaffold
|
||||||
|
run: |
|
||||||
|
curl -Lo skaffold https://storage.googleapis.com/skaffold/releases/latest/skaffold-linux-amd64
|
||||||
|
sudo install skaffold /usr/local/bin/
|
||||||
|
skaffold version
|
||||||
|
|
||||||
|
- name: Build and Install Fission
|
||||||
|
run: |
|
||||||
|
kubectl create ns fission
|
||||||
|
kubectl create -k crds/v1
|
||||||
|
skaffold run -p kind-ci
|
||||||
|
|
||||||
|
- name: Build and Install Fission CLI
|
||||||
|
run: |
|
||||||
|
sudo make install-fission-cli
|
||||||
|
sudo chmod +x /usr/local/bin/fission
|
||||||
|
|
||||||
|
- name: Port-forward fission components
|
||||||
|
run: |
|
||||||
|
kubectl port-forward svc/router 8888:80 -nfission &
|
||||||
|
kubectl port-forward svc/controller 8889:80 -nfission &
|
||||||
|
kubectl port-forward svc/nats-streaming 8890:4222 -nfission &
|
||||||
|
|
||||||
|
- name: Get fission version
|
||||||
|
run: |
|
||||||
|
fission version
|
||||||
|
|
||||||
|
- name: Integration tests
|
||||||
|
run: ./test/kind_CI.sh
|
||||||
|
|
||||||
|
- name: Collect Fission Dump
|
||||||
|
if: ${{ always() }}
|
||||||
|
run: |
|
||||||
|
command -v fission && fission support dump
|
||||||
|
|
||||||
|
- name: Archive fission dump
|
||||||
|
if: ${{ failure() }}
|
||||||
|
uses: actions/upload-artifact@v2
|
||||||
|
with:
|
||||||
|
name: fission-dump
|
||||||
|
path: fission-dump/*.zip
|
||||||
|
retention-days: 5
|
||||||
@@ -0,0 +1,97 @@
|
|||||||
|
name: Fission CI upgrade
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
paths:
|
||||||
|
- '**.go'
|
||||||
|
- 'charts/**'
|
||||||
|
- 'test/**'
|
||||||
|
- go.mod
|
||||||
|
- go.sum
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
paths:
|
||||||
|
- '**.go'
|
||||||
|
- 'charts/**'
|
||||||
|
- 'test/**'
|
||||||
|
- go.mod
|
||||||
|
- go.sum
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
upgrade-test:
|
||||||
|
runs-on: ${{ matrix.os }}
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
kindimage : [ 'kindest/node:v1.19.11' ]
|
||||||
|
os: [ ubuntu-latest ]
|
||||||
|
steps:
|
||||||
|
- name: Setup go
|
||||||
|
uses: actions/setup-go@v2.1.3
|
||||||
|
with:
|
||||||
|
go-version: '1.15.12'
|
||||||
|
|
||||||
|
- name: Checkout action sources
|
||||||
|
uses: actions/checkout@v2.3.4
|
||||||
|
|
||||||
|
- uses: actions/cache@v2
|
||||||
|
with:
|
||||||
|
path: ~/go/pkg/mod
|
||||||
|
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
|
||||||
|
restore-keys: |
|
||||||
|
${{ runner.os }}-go-
|
||||||
|
|
||||||
|
- name: Setup Helm
|
||||||
|
uses: Azure/setup-helm@v1
|
||||||
|
with:
|
||||||
|
version: v3.3.4
|
||||||
|
|
||||||
|
- name: Setup Kind Clutser
|
||||||
|
uses: engineerd/setup-kind@v0.5.0
|
||||||
|
with:
|
||||||
|
image: ${{ matrix.kindimage }}
|
||||||
|
version: v0.11.1
|
||||||
|
|
||||||
|
- name: Setup kubectl & fetch node information
|
||||||
|
run: |
|
||||||
|
kubectl cluster-info --context kind-kind
|
||||||
|
kubectl get nodes
|
||||||
|
kubectl get storageclasses.storage.k8s.io
|
||||||
|
|
||||||
|
- name: Dump system info
|
||||||
|
run: |
|
||||||
|
source ./test/upgrade_test/fission_objects.sh dump_system_info
|
||||||
|
|
||||||
|
- name: Install and configure previous stable fission
|
||||||
|
run: |
|
||||||
|
source ./test/upgrade_test/fission_objects.sh install_stable_release \
|
||||||
|
&& create_fission_objects \
|
||||||
|
&& test_fission_objects
|
||||||
|
|
||||||
|
- name: Upgrade fission to latest
|
||||||
|
run: |
|
||||||
|
source ./test/upgrade_test/fission_objects.sh build_docker_images \
|
||||||
|
&& kind_image_load \
|
||||||
|
&& install_current_release \
|
||||||
|
&& install_fission_cli
|
||||||
|
|
||||||
|
- name: Test previously created fission objects with new release
|
||||||
|
run: |
|
||||||
|
source ./test/upgrade_test/fission_objects.sh test_fission_objects
|
||||||
|
|
||||||
|
- name: Collect Fission Dump
|
||||||
|
if: ${{ always() }}
|
||||||
|
run: |
|
||||||
|
command -v fission && fission support dump
|
||||||
|
|
||||||
|
- name: Archive fission dump
|
||||||
|
if: ${{ failure() }}
|
||||||
|
uses: actions/upload-artifact@v2
|
||||||
|
with:
|
||||||
|
name: fission-dump
|
||||||
|
path: fission-dump/*.zip
|
||||||
|
retention-days: 5
|
||||||
@@ -1,16 +1,33 @@
|
|||||||
fission-bundle/fission-bundle
|
# Binaries
|
||||||
fission/fission
|
cmd/fission-bundle/fission-bundle
|
||||||
|
cmd/fission-cli/fission
|
||||||
|
cmd/fission-cli/fission-cli
|
||||||
|
cmd/fetcher/fetcher
|
||||||
|
cmd/builder/builder
|
||||||
|
cmd/preupgradechecks/pre-upgrade-checks
|
||||||
|
cmd/reporter/reporter
|
||||||
|
|
||||||
|
# Logs
|
||||||
|
test/logs/
|
||||||
|
|
||||||
# Pycharm IDE
|
# Pycharm IDE
|
||||||
.idea
|
.idea
|
||||||
environments/php7/vendor/
|
environments/php7/vendor/
|
||||||
|
|
||||||
|
# terraform files
|
||||||
|
.terraform/
|
||||||
|
*.tfstate
|
||||||
|
*.backup
|
||||||
|
|
||||||
# Common backup files
|
# Common backup files
|
||||||
*.swp
|
*.swp
|
||||||
*.bak
|
*.bak
|
||||||
*.tmp
|
*.tmp
|
||||||
*~
|
*~
|
||||||
|
*.tgz
|
||||||
|
|
||||||
.DS_Store
|
.DS_Store
|
||||||
vendor/
|
vendor/
|
||||||
local/
|
local/
|
||||||
|
|
||||||
|
build/
|
||||||
|
|||||||
@@ -0,0 +1,38 @@
|
|||||||
|
linters:
|
||||||
|
enable:
|
||||||
|
# Default linter
|
||||||
|
- deadcode
|
||||||
|
- errcheck
|
||||||
|
- gosimple
|
||||||
|
- govet
|
||||||
|
- ineffassign
|
||||||
|
- staticcheck
|
||||||
|
- structcheck
|
||||||
|
- typecheck
|
||||||
|
- unused
|
||||||
|
- varcheck
|
||||||
|
# Additional linters
|
||||||
|
- gofmt
|
||||||
|
- goimports
|
||||||
|
- misspell
|
||||||
|
- nakedret
|
||||||
|
- unconvert
|
||||||
|
# Enable in future
|
||||||
|
# - bodyclose
|
||||||
|
# - dogsled
|
||||||
|
# - dupl
|
||||||
|
# - gosec
|
||||||
|
# - ifshort
|
||||||
|
# - nilerr
|
||||||
|
# - prealloc
|
||||||
|
# - revive
|
||||||
|
# - unparam
|
||||||
|
# - wrapcheck
|
||||||
|
# - gocritic
|
||||||
|
linters-settings:
|
||||||
|
errcheck:
|
||||||
|
ignore: go.uber.org/zap:Sync
|
||||||
|
goimports:
|
||||||
|
# put imports beginning with prefix after 3rd-party packages;
|
||||||
|
# it's a comma-separated list of prefixes
|
||||||
|
local-prefixes: github.com/fission/fission
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
sudo: required
|
|
||||||
|
|
||||||
dist: trusty
|
|
||||||
|
|
||||||
branches:
|
|
||||||
only:
|
|
||||||
- master
|
|
||||||
|
|
||||||
language: go
|
|
||||||
|
|
||||||
go:
|
|
||||||
- 1.8
|
|
||||||
|
|
||||||
cache:
|
|
||||||
directories:
|
|
||||||
- $HOME/google-cloud-sdk/
|
|
||||||
- $HOME/k8scli
|
|
||||||
|
|
||||||
services:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
before_install:
|
|
||||||
- sudo apt-get update
|
|
||||||
- sudo apt-get -y -o Dpkg::Options::="--force-confnew" install docker-ce
|
|
||||||
- sudo sysctl net.ipv6.conf.all.disable_ipv6=0
|
|
||||||
|
|
||||||
install:
|
|
||||||
- go get github.com/Masterminds/glide
|
|
||||||
- hack/travis-kube-setup.sh
|
|
||||||
|
|
||||||
env:
|
|
||||||
- KUBECONFIG=${HOME}/.kube/config PATH=$HOME/k8scli:${PATH}
|
|
||||||
|
|
||||||
script:
|
|
||||||
- cd ${TRAVIS_BUILD_DIR}
|
|
||||||
- glide install -v
|
|
||||||
- ./fission-bundle/build.sh
|
|
||||||
- hack/verify-gofmt.sh
|
|
||||||
- hack/verify-govet.sh
|
|
||||||
- hack/runtests.sh
|
|
||||||
- test/build_and_test.sh
|
|
||||||
- test/upgrade/fission_upgrade_test.sh
|
|
||||||
|
|
||||||
notifications:
|
|
||||||
slack:
|
|
||||||
rooms:
|
|
||||||
secure: YZ34vsfw1TtftJypg1MyP4+ihONI4gaxeS3FghBQli6+EezjzcxOXyj5VD+x0ucXfDeTaDrFfmVN0SAGObOoZUE+ea9KAoTo50tRLaD9kwOTACiekZalC4uuBguH0D1/A6vlbU8dchsr9mvIhbisG6mTncdPtqGYYHtyBQme6ngmmHbVAQFZcIBHmNuDb/HWhSr8KMEuyB6+mBXLYELHnXnf26cOhdGNaagqCOJTiemX85RGwIuOPxyBhKDFMLyHohDT7FJMH/qijveE6YgOYTQC5nYc2Np1KvC7hQkIu4nuyczyYlrNQl/TWv+SVI8PjIs0PYuCuD3gUqoVEi8d94HbrOPzFEpbwDS9P4qL39DGmco1Q56Vqxe6sRI0vDWPb5gCP1lSgs3PMECVn7Wor/pTvcL+C+U2jLwWJUl0vbyWCL7ngl/3iTssV7qBpUrI7Oclwp8LrQo9fPj0DL4gE9rNanpEWjQ6yPGaysIL1zLHtRghhm52A22NJGp71jkS2KEpLi6ZWFYjMeuXw5eOQFhqFlzyRJOmLYa3B607TLWuyo2L2CxAfMmq0FGfemvrkLZIWtlQKK4y9ImpsURwaGT2XCtThFtHl77wEss913nC+T2dX3O5Bl0UmxFd5S3mVM109I8c4lDosxnAjRfS9MheFlrG0gjSJSBCw57x7f0=
|
|
||||||
on_success: change
|
|
||||||
on_failure: always
|
|
||||||
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
|
|||||||
## Enforcement
|
## Enforcement
|
||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
reported by contacting the project team at codeofconduct@platform9.com. All
|
reported by contacting the project team at slack channel. All
|
||||||
complaints will be reviewed and investigated and will result in a response that
|
complaints will be reviewed and investigated and will result in a response that
|
||||||
is deemed necessary and appropriate to the circumstances. The project team is
|
is deemed necessary and appropriate to the circumstances. The project team is
|
||||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||||
|
|||||||
@@ -1,46 +1,239 @@
|
|||||||
# Contributing to Fission
|
|
||||||
|
|
||||||
### Thank you!
|
Thanks for helping make Fission better😍!
|
||||||
|
|
||||||
Thank you for taking the time and effort to contribute to Fission!
|
There are many areas we can use contributions - ranging from code, documentation, feature proposals, issue triage, samples, and content creation.
|
||||||
|
|
||||||
First, please read the [code of conduct](CODE_OF_CONDUCT.md). By
|
First, please read the [code of conduct](CODE_OF_CONDUCT.md). By participating, you're expected to uphold this code.
|
||||||
participating, you're expected to uphold this code.
|
|
||||||
|
|
||||||
### Choose something to work on
|
Table of Contents
|
||||||
|
=================
|
||||||
|
|
||||||
The easiest way to start is to look at existing
|
* [Choose something to work on](#choose-something-to-work-on)
|
||||||
[issues](https://github.com/fission/fission/issues) and see if there's
|
* [Get Help.](#get-help)
|
||||||
something there that you'd like to work on.
|
* [Contributing - building & deploying](#contributing---building--deploying)
|
||||||
|
* [Prerequisite](#prerequisite)
|
||||||
|
* [Getting Started](#getting-started)
|
||||||
|
* [Use Skaffold with Kind/K8S Cluster to build and deploy](#use-skaffold-with-kindk8s-cluster-to-build-and-deploy)
|
||||||
|
* [Validating Installation](#validating-installation)
|
||||||
|
* [Understanding code structure](#understanding-code-structure)
|
||||||
|
* [cmd](#cmd)
|
||||||
|
* [pkg](#pkg)
|
||||||
|
* [Charts](#charts)
|
||||||
|
* [Environments](#environments)
|
||||||
|
|
||||||
Also, if you're familiar with a language that we don't support today,
|
# Choose something to work on
|
||||||
adding an environment for a new language is a good task to take on.
|
|
||||||
Take a look at the Python environment as an example.
|
|
||||||
|
|
||||||
If you're interested in working on something that doesn't have an
|
* The easiest way to start is to look at existing [issues](https://github.com/fission/fission/issues) and see if there's something there that you'd like to work on. You can filter issues with label "[Good first issue](https://github.com/fission/fission/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)" which are relatively self sufficient issues and great for first time contributors.
|
||||||
existing issue, feel free to file a new one.
|
- If you are going to pick up an issue, it would be good to add a comment stating the intention.
|
||||||
|
- If the contribution is a big change/new feature, please raise an issue and discuss the needs, design in the issue in detail.
|
||||||
|
|
||||||
There's plenty of stuff to do. If you need help choosing something to
|
* For contributing a new Fission environment, please check the [environments repo](https://github.com/fission/environments)
|
||||||
work on, we'll be happy to suggest something depending on your
|
|
||||||
interests.
|
|
||||||
|
|
||||||
### Talk to people
|
* For contributing a new Keda Connector, please check the [Keda Connectors repo](https://github.com/fission/keda-connectors)
|
||||||
|
|
||||||
At any point, from thinking about contributing to merging your
|
|
||||||
changes, please feel free to reach out to us! We're more than happy
|
|
||||||
to talk.
|
|
||||||
|
|
||||||
If you choose a big chunk of work that involves design changes to
|
### Get Help.
|
||||||
Fission, please talk to us while planning the change; that way we can
|
|
||||||
all be on the same page before you invest too much work into it.
|
|
||||||
|
|
||||||
* Drop by the [slack channel](http://slack.fission.io)
|
Do reach out on Slack or Twitter and we are happy to help.
|
||||||
|
|
||||||
|
* Drop by the [slack channel](http://slack.fission.io).
|
||||||
* Say hi on [twitter](https://twitter.com/fissionio).
|
* Say hi on [twitter](https://twitter.com/fissionio).
|
||||||
* Email soamvasani@platform9.com
|
|
||||||
|
|
||||||
### Contribution Howto
|
|
||||||
|
|
||||||
* Fork this github repo
|
# Contributing - building & deploying
|
||||||
* Make a branch in your fork
|
|
||||||
* Commit your changes to that branch
|
## Prerequisite
|
||||||
* Create a pull request
|
|
||||||
|
- You'll need the `go` compiler and tools installed. Currently version 1.12.x of Go is needed.
|
||||||
|
|
||||||
|
- You'll also need [docker](https://docs.docker.com/install) for building images locally.
|
||||||
|
|
||||||
|
- You will need a Kubernetes cluster and you can use one of options from below.
|
||||||
|
- [Minikube](https://github.com/kubernetes/minikube)
|
||||||
|
- [Kind](https://kind.sigs.k8s.io/)
|
||||||
|
- Cluster in cloud such as GKE (Google Kubernetes Engine cluster)/ EKS (Elastic Kubernetes Service)/ AKS (Azure Kubernetes Service)
|
||||||
|
|
||||||
|
- Kubectl and Helm installed.
|
||||||
|
|
||||||
|
- [Skaffold](https://skaffold.dev/docs/install/) for local development workflow to make it easier to build and deploy Fission.
|
||||||
|
|
||||||
|
- And of course some basic concepts of Fission such as environment, function are good to be aware of!
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
Get the code locally and after you have made changes - you can verify formatting and other basic checks.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Clone the repo
|
||||||
|
$ git clone https://github.com/fission/fission.git $GOPATH/src/github.com/fission/fission
|
||||||
|
$ cd $GOPATH/src/github.com/fission/fission
|
||||||
|
|
||||||
|
$ go mod vendor
|
||||||
|
|
||||||
|
# Run checks on your changes
|
||||||
|
$ ./hack/verify-gofmt.sh
|
||||||
|
$ ./hack/verify-govet.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
### Use Skaffold with Kind/K8S Cluster to build and deploy
|
||||||
|
|
||||||
|
You should bring up Kind/Minikube cluster or if using a cloud provider cluster then Kubecontext should be pointing to appropriate cluster.
|
||||||
|
|
||||||
|
* For building & deploying to Cloud Provider K8S cluster such as GKE/EKS/AKS:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ skaffold config set default-repo vishalbiyani // (vishalbiyani - should be your registry/Docker Hub handle)
|
||||||
|
$ skaffold run
|
||||||
|
```
|
||||||
|
|
||||||
|
* For building & deploying to Kind cluster use Kind profile
|
||||||
|
```
|
||||||
|
$ kind create cluster
|
||||||
|
$ kubectl create ns fission
|
||||||
|
$ skaffold run -p kind
|
||||||
|
```
|
||||||
|
|
||||||
|
## Validating Installation
|
||||||
|
|
||||||
|
If you are using Helm, you should see release installed:
|
||||||
|
|
||||||
|
```
|
||||||
|
helm list
|
||||||
|
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
|
||||||
|
fission fission 1 2020-05-19 16:31:46.947562 +0530 IST success fission-all-1.11.0 1.11.0
|
||||||
|
```
|
||||||
|
|
||||||
|
Also you should see the Fission services deployed and running:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ kubectl get pods -n fission
|
||||||
|
NAME READY STATUS RESTARTS AGE
|
||||||
|
buildermgr-6f778d4ff9-dqnq5 1/1 Running 0 6h9m
|
||||||
|
controller-d44bd4f4d-5q4z5 1/1 Running 0 6h9m
|
||||||
|
executor-557c68c6fd-dg8ld 1/1 Running 0 6h9m
|
||||||
|
influxdb-845548c959-2954p 1/1 Running 0 6h9m
|
||||||
|
kubewatcher-5784c454b8-5mqsk 1/1 Running 0 6h9m
|
||||||
|
logger-bncqn 2/2 Running 0 6h9m
|
||||||
|
mqtrigger-kafka-765b674ff-jk5x9 1/1 Running 0 6h9m
|
||||||
|
mqtrigger-nats-streaming-797498966c-xgxmk 1/1 Running 3 6h9m
|
||||||
|
nats-streaming-6bf48bccb6-fmmr9 1/1 Running 0 6h9m
|
||||||
|
router-db76576bd-xxh7r 1/1 Running 0 6h9m
|
||||||
|
storagesvc-799dcb5bdf-f69k9 1/1 Running 0 6h9m
|
||||||
|
timer-7d85d9c9fb-knctw 1/1 Running 0 6h9m
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Understanding code structure
|
||||||
|
|
||||||
|
### cmd
|
||||||
|
|
||||||
|
`cmd` package is entry point for all runtime components and also has Dockerfile for each component. The actual logic here will be pretty light and most of logic of each component is in `pkg` (Discussed later)
|
||||||
|
|
||||||
|
| Component | Runtime Component |Used in|
|
||||||
|
| :------------- |:------------- |:-|
|
||||||
|
| fetcher | Docker Image |Environments|
|
||||||
|
| fission-bundle | Docker Image |Binary for all components|
|
||||||
|
| fission-cli | CLI Binary |CLI by user|
|
||||||
|
| preupgradechecks | Docker Image |Pre-install upgrade|
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
cmd
|
||||||
|
├── fetcher
|
||||||
|
│ ├── Dockerfile.fission-fetcher
|
||||||
|
│ ├── app
|
||||||
|
│ └── main.go
|
||||||
|
├── fission-bundle
|
||||||
|
│ ├── Dockerfile.fission-bundle
|
||||||
|
│ ├── main.go
|
||||||
|
│ └── mqtrigger
|
||||||
|
├── fission-cli
|
||||||
|
│ ├── app
|
||||||
|
│ ├── fission-cli
|
||||||
|
│ └── main.go
|
||||||
|
└── preupgradechecks
|
||||||
|
├── Dockerfile.fission-preupgradechecks
|
||||||
|
├── main.go
|
||||||
|
└── preupgradechecks.go
|
||||||
|
```
|
||||||
|
|
||||||
|
**fetcher** : is a very lightweight component and all of related logic is in fetcher package itself. Fetcher helps in fetching and uploading code and in specializing environments.
|
||||||
|
|
||||||
|
**fission-bundle** : is a component which is a single binary for all components. Based on arguments you pass to fission-bundle - it becomes that component. For ex.
|
||||||
|
|
||||||
|
```
|
||||||
|
/fission-bundle --controllerPort "8888" # Runs Controller
|
||||||
|
|
||||||
|
/fission-bundle --kubewatcher --routerUrl http://router.fission # Runs Kubewatcher
|
||||||
|
```
|
||||||
|
|
||||||
|
So most server side components running on server side are fission-bundle binary wrapped in container and used with different arguments. Various arguments and environment variables are passed from manifests/helm chart
|
||||||
|
|
||||||
|
**fission-cli** : is the cli used by end user to interact Fission
|
||||||
|
|
||||||
|
**preupgradechecks** : is again a small independent component to do pre-install upgrade tasks.
|
||||||
|
|
||||||
|
|
||||||
|
### pkg
|
||||||
|
|
||||||
|
Pkg is where most of core components and logic reside. The structure is fairly self-explanatory for example all of executor related functionality will be in executor package and so on.
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
├── pkg
|
||||||
|
│ ├── apis
|
||||||
|
│ ├── builder
|
||||||
|
│ ├── buildermgr
|
||||||
|
│ ├── cache
|
||||||
|
│ ├── canaryconfigmgr
|
||||||
|
│ ├── controller
|
||||||
|
│ ├── crd
|
||||||
|
│ ├── error
|
||||||
|
│ ├── executor
|
||||||
|
│ ├── fetcher
|
||||||
|
│ ├── fission-cli
|
||||||
|
│ ├── generator
|
||||||
|
│ ├── info
|
||||||
|
│ ├── kubewatcher
|
||||||
|
│ ├── logger
|
||||||
|
│ ├── mqtrigger
|
||||||
|
│ ├── plugin
|
||||||
|
│ ├── publisher
|
||||||
|
│ ├── router
|
||||||
|
│ ├── storagesvc
|
||||||
|
│ ├── throttler
|
||||||
|
│ ├── timer
|
||||||
|
│ └── utils
|
||||||
|
```
|
||||||
|
|
||||||
|
### Charts
|
||||||
|
|
||||||
|
Fission currently has two charts - and we recommend using fission-all for development.
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
├── charts
|
||||||
|
│ ├── README.md
|
||||||
|
│ ├── fission-all
|
||||||
|
│ └── fission-core
|
||||||
|
```
|
||||||
|
|
||||||
|
### Environments
|
||||||
|
|
||||||
|
Each of runtime environments is in fission/environments repo and fairly independent. If you are enhancing or creating a new environment - most likely you will end up making changes in that repo.
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
├── environments
|
||||||
|
│ ├── binary
|
||||||
|
│ ├── dotnet
|
||||||
|
│ ├── dotnet20
|
||||||
|
│ ├── go
|
||||||
|
│ ├── jvm
|
||||||
|
│ ├── nodejs
|
||||||
|
│ ├── perl
|
||||||
|
│ ├── php7
|
||||||
|
│ ├── python
|
||||||
|
│ ├── ruby
|
||||||
|
│ └── tensorflow-serving
|
||||||
|
```
|
||||||
|
|||||||
@@ -1,52 +0,0 @@
|
|||||||
Compiling Fission
|
|
||||||
=================
|
|
||||||
|
|
||||||
[You only need to do this if you're making Fission changes; if you're
|
|
||||||
just deploying Fission, use fission.yaml which points to prebuilt
|
|
||||||
images.]
|
|
||||||
|
|
||||||
You'll need the `go` compiler and tools installed, along with the
|
|
||||||
[glide dependency management
|
|
||||||
tool](https://github.com/Masterminds/glide#install). You'll also need
|
|
||||||
docker for building images.
|
|
||||||
|
|
||||||
The server side is compiled as one binary ("fission-bundle") which
|
|
||||||
contains controller, poolmgr and router; it invokes the right one
|
|
||||||
based on command-line arguments.
|
|
||||||
|
|
||||||
To build fission-bundle: clone this repo to
|
|
||||||
`$GOPATH/src/github.com/fission/fission`, then from the top level
|
|
||||||
directory (if you want to build the image with the docker inside
|
|
||||||
minikube, you'll need to set the proper environment variables with
|
|
||||||
`eval $(minikube docker-env)`):
|
|
||||||
|
|
||||||
```
|
|
||||||
# Get dependencies
|
|
||||||
$ glide install -v
|
|
||||||
|
|
||||||
# Build fission server and an image
|
|
||||||
$ pushd fission-bundle
|
|
||||||
$ ./build.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
You now need to build the docker image for fission. You can use
|
|
||||||
`push.sh` and push it to a docker hub account. But it's easiest to use
|
|
||||||
minikube and its built-in docker daemon:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ eval $(minikube docker-env)
|
|
||||||
$ docker build -t minikube/fission-bundle .
|
|
||||||
```
|
|
||||||
|
|
||||||
Next, install fission with this image on your kubernetes cluster using the helm chart:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ helm install --set "image=minikube/fission-bundle,imageTag=latest,pullPolicy=IfNotPresent,analytics=false" charts/fission-all
|
|
||||||
```
|
|
||||||
|
|
||||||
And if you're changing the CLI too, you can build it with:
|
|
||||||
|
|
||||||
```
|
|
||||||
# Build Fission CLI
|
|
||||||
$ cd fission && go install
|
|
||||||
```
|
|
||||||
@@ -1,105 +1,186 @@
|
|||||||
|
# A high-level view of the internals of Fission.
|
||||||
|
|
||||||
A high level view of the internals of Fission.
|
## How it works
|
||||||
|
|
||||||
How it works
|
|
||||||
============
|
|
||||||
|
|
||||||
Fission is a FaaS -- users create functions (source level), register
|
Fission is a FaaS -- users create functions (source level), register
|
||||||
them with fission using a CLI, and associate functions with triggers.
|
them with Fission using a CLI, and associate functions with triggers.
|
||||||
|
|
||||||
Fission wraps those functions into a service, and runs them on
|
Fission wraps those functions into a service and runs them on
|
||||||
Kubernetes on demand.
|
Kubernetes on demand.
|
||||||
|
|
||||||
Here's an overview of the services that make up fission.
|
Here's an overview of the services that make up Fission.
|
||||||
|
|
||||||
Components
|
## Components
|
||||||
==========
|
|
||||||
|
|
||||||
Language-neutral components:
|
Core Components:
|
||||||
|
* Controller
|
||||||
|
* Executor
|
||||||
|
* Environment Container (language-specific)
|
||||||
|
* Router
|
||||||
|
* Builder Manager
|
||||||
|
* Storage Service
|
||||||
|
|
||||||
* controller
|
Optional Components:
|
||||||
* poolmgr
|
* Logger
|
||||||
* router
|
* Kubewatcher
|
||||||
* kubewatcher
|
* Message Queue Trigger
|
||||||
|
* Timer
|
||||||
|
|
||||||
Language-specific components:
|
Third-party components:
|
||||||
|
* InfluxDB: To store function logs.
|
||||||
|
* Prometheus: For metric collection and canary deployment.
|
||||||
|
* NATS Streaming: For message queue trigger. (Kafka, Azure are not included in charts deployment.)
|
||||||
|
|
||||||
* Environment container(s)
|
## Core Components
|
||||||
|
|
||||||
|
### Controller
|
||||||
|
|
||||||
Controller
|
The controller contains CRUD APIs for functions, triggers, environments,
|
||||||
----------
|
Kubernetes event watches, etc. This is the component that the client talks to.
|
||||||
|
|
||||||
The controller contains CRUD APIs for functions, http triggers,
|
All fission resources are stored in kubernetes CRDs. It needs to be able to
|
||||||
environments, Kubernetes event watches. This is the component that
|
talk to kubernetes API service.
|
||||||
the client talks to.
|
|
||||||
|
|
||||||
This is the only stateful component. It needs to be configured with a
|
### Executor
|
||||||
URL to an etcd cluster and a path to a persistent volume. The volume
|
|
||||||
is used to store the functions' source code. Etcd is used as the DB.
|
|
||||||
|
|
||||||
[Work to extend to other storage backends is planned, see issue #83.]
|
The executor has two simple APIs; the router calls both these endpoints.
|
||||||
|
|
||||||
Pool Manager
|
* GetFunctionService takes function metadata and dispatches the corresponding executor
|
||||||
------------
|
type to get the address of a service/pod and returns it to the router.
|
||||||
|
|
||||||
Poolmgr manages pools of generic containers and function containers.
|
* TapService lets executor know a service/pod is being used; if it's not
|
||||||
|
called for a few minutes the pod(s) backing the service are killed.
|
||||||
|
|
||||||
It has a simple API; both these endpoints are called by the router.
|
It now supports two different executor types:
|
||||||
|
|
||||||
* GetFunctionService takes function metadata and returns the address
|
* PoolManager
|
||||||
of a service.
|
* NewDeploy
|
||||||
|
|
||||||
* TapService lets poolmgr know a service is being used; if it's not
|
These two executor types have different strategies to launch, specialize, and manage pod(s).
|
||||||
called for a few minutes the pod(s) backing the service are killed.
|
You should choose one of the executor types wisely based on the scenario.
|
||||||
|
|
||||||
Poolmgr watches the controller API and eagerly creates generic pools
|
#### PoolManager
|
||||||
for environments. It uses Kubernetes deployments to do that. The
|
|
||||||
|
PoolManager manages pools of generic containers and function containers.
|
||||||
|
|
||||||
|
PoolManager watches the environment CRD changes and eagerly creates generic pools
|
||||||
|
for environments. It uses Kubernetes deployments to do that. The
|
||||||
environment container runs in a pod with the 'fetcher' container.
|
environment container runs in a pod with the 'fetcher' container.
|
||||||
Fetcher is a very simple utility that downloads a URL sent to it and
|
Fetcher is a straightforward utility that downloads a URL sent to it
|
||||||
saves it at a configured location.
|
and saves it at a configured location (shared volume).
|
||||||
|
|
||||||
GetFunctionService "specializes" a pod. The implementation chooses a
|
The implementation chooses a generic pod from the pool, relabels it to
|
||||||
pod from the pool, relabels it to "orphan" the pod from the
|
"orphan". The pod from the deployment invokes fetcher to copy the function
|
||||||
deployment, invokes fetcher to copy the function into the pod, and
|
into the pod and hits the specialize endpoint on the environment container.
|
||||||
hits the the specialize endpoint on the environment container. This
|
This causes the function to be loaded. The pod is now specific to that
|
||||||
causes the function to be loaded. The pod is now specific to that
|
function. This function pod is cached; it's cleaned up if it's unused for a few minutes.
|
||||||
function.
|
|
||||||
|
|
||||||
This function pod is cached; it's cleaned up if it's unused for a few
|
PoolManager selects a generic pod from the warm pool, specializes it,
|
||||||
minutes.
|
and recycles the pod if there are no further requests to the function after a few minutes.
|
||||||
|
It makes PoolManager suitable for functions that are short-living
|
||||||
|
and requires a short cold start time [1].
|
||||||
|
|
||||||
Router
|
However, PoolManager only selects one pod per function, which is not
|
||||||
------
|
suitable for serving massive traffic. In such cases, you should consider
|
||||||
|
using NewDeploy as executor type of function.
|
||||||
|
|
||||||
The router forwards HTTP requests to function pods. If there's no
|
[1] The cold start time depends on the package size of the function. If it's
|
||||||
running service for a function, it requests one from poolmgr, while
|
a snippet of code, the cold start time usually is less then 100ms.
|
||||||
holding on to the request; when the function's service is ready it
|
|
||||||
forwards the request.
|
|
||||||
|
|
||||||
The router is stateless and can be scaled up if needed, according to
|
#### NewDeploy
|
||||||
|
|
||||||
|
NewDeploy creates deployment, service, and HPA for functions in order to handle
|
||||||
|
massive traffic.
|
||||||
|
|
||||||
|
NewDeploy watches the function CRD changes and creates a Kubernetes deployment,
|
||||||
|
service, and HPA for a function. NewDeploy will scale the replicas of a function
|
||||||
|
deployment to the minimum feasible scale setting, if the minimum scale setting of
|
||||||
|
a function is greater than 0. The 'fetcher' inside the pod uses a URL in the
|
||||||
|
JSON payload, which is attached as a parameter to start fetcher, to download the
|
||||||
|
function package instead of waiting for calls from NewDeploy.
|
||||||
|
|
||||||
|
When a function experiences a traffic spike, the service helps to distribute the requests to
|
||||||
|
pods belonging to the function for better workload distribution and lower latency. Also,
|
||||||
|
the HPA scales the replicas of the deployment based on the conditions set by the user.
|
||||||
|
|
||||||
|
This approach though increases the cold time of a function, but also makes NewDeploy
|
||||||
|
suitable for functions designed to serve massive traffic.
|
||||||
|
|
||||||
|
### Environment Container
|
||||||
|
|
||||||
|
Environment containers run user-defined functions and are language-specific.
|
||||||
|
Each environment container must contain an HTTP server and a loader for functions.
|
||||||
|
|
||||||
|
The pool manager deploys the environment container into a pod with fetcher
|
||||||
|
(fetcher is a simple utility that can fetch an HTTP URL to a file at a
|
||||||
|
configured location). This pod forms a "generic pod" because it can
|
||||||
|
be loaded with any function in that coding language.
|
||||||
|
|
||||||
|
When the pool manager needs to create a service for a function, it calls
|
||||||
|
fetcher to fetch the function. Fetcher downloads the function into a
|
||||||
|
volume shared between fetcher and this environment container. Poolmgr
|
||||||
|
then requests the container to load the function.
|
||||||
|
|
||||||
|
### Router
|
||||||
|
|
||||||
|
The router forwards HTTP requests to function pods. If there's no
|
||||||
|
running service for a function, it requests one from executor, while
|
||||||
|
holding on to the request; the router will forward the request to
|
||||||
|
the pod once the function service is ready.
|
||||||
|
|
||||||
|
The router is the only stateless component and can be scaled up if needed, according to
|
||||||
load.
|
load.
|
||||||
|
|
||||||
Kubewatcher
|
### Builder Manager
|
||||||
-----------
|
|
||||||
|
The builder manager watches the package & environments CRD changes and manages
|
||||||
|
the builds of function source code. Once an environment that contains a builder
|
||||||
|
image is created, the builder manager will then creates the Kubernetes service
|
||||||
|
and deployment under the fission-builder namespace to start the environment
|
||||||
|
builder. And once a package that contains a source archive is created, the
|
||||||
|
builder manager talks to the environment builder to build the function's source
|
||||||
|
archive into a deploy archive for function deployment.
|
||||||
|
|
||||||
|
After the build, the builder manager asks Builder to upload the deploy archive to the
|
||||||
|
Storage Service once the build succeeded, and updates the package status attached with build logs.
|
||||||
|
|
||||||
|
### Storage Service
|
||||||
|
|
||||||
|
The storage service is the home for all archives of packages with sizes larger than 256KB.
|
||||||
|
The Builder pulls the source archive from the storage service and uploads deploy archive to it.
|
||||||
|
The fetcher inside the function pod also pulls the deploy archive for function specialization.
|
||||||
|
|
||||||
|
## Optional Components
|
||||||
|
|
||||||
|
### Logger
|
||||||
|
|
||||||
|
Logger is deployed as DaemonSet to help to forward function logs to a centralized
|
||||||
|
database service for log persistence. Currently, only InfluxDB is supported to store logs.
|
||||||
|
|
||||||
|
Following is a diagram describe how log service works:
|
||||||
|
1. Logger watches pod changes and creates a symlink to the container log if the pod runs on the same node.
|
||||||
|
2. Fluentd reads logs from symlink and pipes them to InfluxDB
|
||||||
|
3. `fission function logs ...` retrieve event logs from InfluxDB with optional log filter
|
||||||
|
4. Logger removes the symlink if the pod no longer exists.
|
||||||
|
|
||||||
|
### Kubewatcher
|
||||||
|
|
||||||
Kubewatcher watches the Kubernetes API and invokes functions
|
Kubewatcher watches the Kubernetes API and invokes functions
|
||||||
associated with watches, sending the watch event to the function.
|
associated with watches, sending the watch event to the function.
|
||||||
|
|
||||||
The controller keeps track of user's requested watches and associated
|
The controller keeps track of the user's requested watches and associated
|
||||||
functions. Kubewatcher watches the API based on these requests; when
|
functions. Kubewatcher watches the API based on these requests; when
|
||||||
a watch event occurs, it serializes the object and calls the function
|
a watch event occurs, it serializes the object and calls the function
|
||||||
via the router.
|
via the router.
|
||||||
|
|
||||||
While a few simple retries are done, there isn't yet a reliable
|
While a few simple retries are done, there isn't yet a reliable
|
||||||
message bus between Kubewatcher and the function. Work for this is
|
message bus between Kubewatcher and the function. Work for this is
|
||||||
tracked in issue #64.
|
tracked in issue #64.
|
||||||
|
|
||||||
Message Queue Trigger
|
### Message Queue Trigger
|
||||||
---------------------
|
|
||||||
|
|
||||||
A message queue trigger binds a message queue topic to a function:
|
A message queue trigger binds a message queue topic to a function:
|
||||||
events from that topic cause the function to be invoked with the
|
Events from that topic cause the function to be invoked with the
|
||||||
message as the body of the request. The trigger may also contain a
|
message as the body of the request. The trigger may also contain a
|
||||||
response topic: if specified, the function's output is sent to this
|
response topic: if specified, the function's output is sent to this
|
||||||
response.
|
response.
|
||||||
@@ -108,37 +189,12 @@ Here's a diagram of the components:
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
Environment Container
|
### Timer
|
||||||
---------------------
|
|
||||||
|
|
||||||
Environment containers run user-defined functions. Environment
|
The timer works like kubernetes CronJob but instead of creating a pod to do the task,
|
||||||
containers are language specific. Each environment container must
|
it sends a request to router to invoke the function. It's suitable for the background tasks that
|
||||||
contain an HTTP server and a loader for functions.
|
need to executor periodically.
|
||||||
|
|
||||||
Poolmgr deploys the environment container into a pod with fetcher
|
The timer works like a Kubernetes CronJob, but instead of creating a
|
||||||
(fetcher is a simple utility that can fetch an HTTP url to a file at a
|
pod to do the task, it sends a request to the router to invoke the
|
||||||
configured location). This pod forms a "generic pod", because it can
|
function. It is suitable for background tasks that need to execute periodically.
|
||||||
be loaded with any function in that language.
|
|
||||||
|
|
||||||
When poolmgr needs to create a service for a function, it calls
|
|
||||||
fetcher to fetch the function. Fetcher downloads the function into a
|
|
||||||
volume shared between fetcher and this environment container. Poolmgr
|
|
||||||
then requests the container to load the function.
|
|
||||||
|
|
||||||
Logger
|
|
||||||
------
|
|
||||||
|
|
||||||
Logger helps to forward function logs to centralized db service for log
|
|
||||||
persistence. Currently only influxdb is supported to store logs.
|
|
||||||
Following is a diagram describe how log service works:
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
1. Pool manager chooses a pod from the pool to execute user function
|
|
||||||
2. Pool manager makes a HTTP POST to logger helper, once helper receives
|
|
||||||
the request it creates a symlink to container log for fluentd.
|
|
||||||
3. Fluentd reads log from symlink and pipes to influxdb
|
|
||||||
4. `fission function logs ...` retrieve event logs from influxdb with
|
|
||||||
optional log filter
|
|
||||||
5. Pool manager removes function pod from pool
|
|
||||||
6. Pool manager asks logger helper to stop piping logs, logger removes symlink.
|
|
||||||
|
|||||||
@@ -0,0 +1,55 @@
|
|||||||
|
# BUILDING MULTI-ARCHITECTURE IMAGES
|
||||||
|
|
||||||
|
While the Docker images for Fission can be built by running:
|
||||||
|
|
||||||
|
```
|
||||||
|
make image
|
||||||
|
```
|
||||||
|
|
||||||
|
the stable images are build for multiple architectures (and automatically pushed to the repository) by
|
||||||
|
|
||||||
|
```
|
||||||
|
make images-multiarch
|
||||||
|
```
|
||||||
|
|
||||||
|
However, there are several options and requirements for building these images, which are explained here.
|
||||||
|
|
||||||
|
## BUILDERS
|
||||||
|
|
||||||
|
We use `docker buildx` to build images for multiple architectures. At the moment, this is considered an
|
||||||
|
experimental feature by Docker, and as such it requires access to experimental features to be enabled
|
||||||
|
in the daemon.json file.
|
||||||
|
|
||||||
|
By default, this will use BuildKit and QEMU emulation support to build the image for each architecture
|
||||||
|
locally. However, for faster building, it is possible to use native nodes to build each architecture,
|
||||||
|
either simple remote Docker instances or a Kubernetes cluster. For information on how to set this up,
|
||||||
|
please see the blog article here:
|
||||||
|
|
||||||
|
<https://www.docker.com/blog/multi-arch-images/>
|
||||||
|
|
||||||
|
And/or the command reference here:
|
||||||
|
|
||||||
|
<https://docs.docker.com/engine/reference/commandline/buildx_create/>
|
||||||
|
|
||||||
|
## BUILD OPTIONS
|
||||||
|
|
||||||
|
### PLATFORMS
|
||||||
|
|
||||||
|
The PLATFORMS variable can be set to a comma-separated list of platforms for which images should be
|
||||||
|
built when running the multi-arch build. If unset, it defaults to _linux/amd64,linux/arm64,linux/arm_.
|
||||||
|
|
||||||
|
### REPOSITORY SELECTION
|
||||||
|
|
||||||
|
By default, the multi-arch build will automatically try to push the resulting images to the fission/*
|
||||||
|
repositories, under the dev tag; i.e. fission/fission-bundle:dev, fission/fetcher:dev, and
|
||||||
|
fission/builder:dev. However, for convenient, this can be customized by setting the REPO and TAG
|
||||||
|
environment variables to set a different repository prefix and tag for the images.
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
```
|
||||||
|
REPO=randomdev TAG=test make images-multiarch
|
||||||
|
```
|
||||||
|
|
||||||
|
would build and push the images randomdev/fission-bundle:test, randomdev/fetcher:test, and
|
||||||
|
randomdev/builder:test . Private Docker repositories can be used in the same manner.
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
Fission Document
|
||||||
|
=================
|
||||||
|
|
||||||
|
* Please visit [here](https://docs.fission.io/) for fission documentation.
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
_Function_: A fission function is something that's mapped to a
|
|
||||||
_trigger_ and run on demand. Though we call it a "function", this is
|
|
||||||
a bit imprecise, since it's actually a module with an function as an
|
|
||||||
entry point -- it doesn't have to be just one function.
|
|
||||||
|
|
||||||
_Trigger_: Triggers are what cause functions to be called. For
|
|
||||||
example, an HTTP trigger causes functions to be called on HTTP
|
|
||||||
requests. Kubernetes Watch triggers cause functions to be called when
|
|
||||||
a Kubernetes watch changes. Future triggers will include message
|
|
||||||
queues, timers, storage systems, etc.
|
|
||||||
|
|
||||||
_Environments_: Environments are the language-specific parts of
|
|
||||||
Fission. Environment containers wrap the user's function and present
|
|
||||||
a common interface to the rest of the fission framework.
|
|
||||||
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# Fission Documentation Website
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
* [Hugo Installation Guide](https://gohugo.io/getting-started/installing/)
|
|
||||||
* Local Preview
|
|
||||||
|
|
||||||
```
|
|
||||||
$ hugo server --buildDrafts --disableFastRender
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
baseURL = "http://fission.io/docs/0.6.1"
|
|
||||||
languageCode = "en-US"
|
|
||||||
defaultContentLanguage = "en"
|
|
||||||
|
|
||||||
title = "Fission: Serverless Functions for Kubernetes"
|
|
||||||
theme = "learn"
|
|
||||||
metaDataFormat = "yaml"
|
|
||||||
defaultContentLanguageInSubdir= true
|
|
||||||
|
|
||||||
[params]
|
|
||||||
editURL = "https://github.com/fission/fission/edit/master/Documentation/docs-site/content/"
|
|
||||||
description = "Documentation for Fission"
|
|
||||||
author = "Fission"
|
|
||||||
showVisitedLinks = false
|
|
||||||
themeVariant = "fission"
|
|
||||||
|
|
||||||
[outputs]
|
|
||||||
home = [ "HTML", "RSS", "JSON"]
|
|
||||||
|
|
||||||
[Languages]
|
|
||||||
[Languages.en]
|
|
||||||
title = "Serverless Functions for Kubernetes"
|
|
||||||
weight = 1
|
|
||||||
languageName = "English"
|
|
||||||
|
|
||||||
[[Languages.en.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-fw fa-github'></i> Github repo"
|
|
||||||
identifier = "ds"
|
|
||||||
url = "https://github.com/fission/fission"
|
|
||||||
weight = 10
|
|
||||||
|
|
||||||
[[Languages.en.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-fw fa-bullhorn'></i> Credits"
|
|
||||||
url = "https://github.com/fission/fission/graphs/contributors"
|
|
||||||
weight = 11
|
|
||||||
@@ -1 +0,0 @@
|
|||||||

|
|
||||||
@@ -1,99 +0,0 @@
|
|||||||
---
|
|
||||||
title: Fission
|
|
||||||
weight: 1
|
|
||||||
---
|
|
||||||
|
|
||||||
Fission: Serverless Functions for Kubernetes
|
|
||||||
============================================
|
|
||||||
|
|
||||||
[fission.io](http://fission.io) [@fissionio](http://twitter.com/fissionio)
|
|
||||||
|
|
||||||
Fission is a fast serverless framework for Kubernetes with a focus on
|
|
||||||
developer productivity and high performance.
|
|
||||||
|
|
||||||
Fission operates on _just the code_: Docker and Kubernetes are
|
|
||||||
abstracted away under normal operation, though you can use both to
|
|
||||||
extend Fission if you want to.
|
|
||||||
|
|
||||||
Fission is extensible to any language; the core is written in Go, and
|
|
||||||
language-specific parts are isolated in something called
|
|
||||||
_environments_ (more below). Fission currently supports NodeJS, Python, Ruby, Go,
|
|
||||||
PHP, Bash, and any Linux executable, with more languages coming soon.
|
|
||||||
|
|
||||||
### Performance: 100msec cold start
|
|
||||||
|
|
||||||
Fission maintains a pool of "warm" containers that each contain a
|
|
||||||
small dynamic loader. When a function is first called,
|
|
||||||
i.e. "cold-started", a running container is chosen and the function is
|
|
||||||
loaded. This pool is what makes Fission fast: cold-start latencies
|
|
||||||
are typically about 100msec.
|
|
||||||
|
|
||||||
### Kubernetes is the right place for Serverless
|
|
||||||
|
|
||||||
We're built on Kubernetes because we think any non-trivial app will
|
|
||||||
use a combination of serverless functions and more conventional
|
|
||||||
microservices, and Kubernetes is a great framework to bring these
|
|
||||||
together seamlessly.
|
|
||||||
|
|
||||||
Building on Kubernetes also means that anything you do for operations
|
|
||||||
on your Kubernetes cluster — such as monitoring or log
|
|
||||||
aggregation — also helps with ops on your Fission deployment.
|
|
||||||
|
|
||||||
|
|
||||||
Fission Concepts
|
|
||||||
----------------
|
|
||||||
|
|
||||||
A _function_ is a piece of code that follows the fission function
|
|
||||||
interface.
|
|
||||||
|
|
||||||
An _environment_ contains the language- and runtime-specific parts of
|
|
||||||
running a function.
|
|
||||||
|
|
||||||
The following environments are currently available:
|
|
||||||
|
|
||||||
|
|
||||||
| Environment | Image |
|
|
||||||
| ------------------------------------ | ------------------------- |
|
|
||||||
| Binary (for executables or scripts) | `fission/binary-env` |
|
|
||||||
| Go | `fission/go-env` |
|
|
||||||
| .NET | `fission/dotnet-env` |
|
|
||||||
| .NET 2.0 | `fission/dotnet20-env` |
|
|
||||||
| NodeJS (Alpine) | `fission/node-env` |
|
|
||||||
| NodeJS (Debian) | `fission/node-env-debian` |
|
|
||||||
| Perl | `fission/perl-env` |
|
|
||||||
| PHP 7 | `fission/php-env` |
|
|
||||||
| Python 3 | `fission/python-env` |
|
|
||||||
| Ruby | `fission/ruby-env` |
|
|
||||||
|
|
||||||
|
|
||||||
You can also extend environments or create entirely new
|
|
||||||
ones if you want. (An environment is essentially just a container
|
|
||||||
with a webserver and dynamic loader.)
|
|
||||||
|
|
||||||
A _trigger_ is something that maps an event to a function; Fission
|
|
||||||
supports HTTP routes as triggers today, with upcoming support for
|
|
||||||
other types of event triggers, such as timers and Kubernetes events.
|
|
||||||
|
|
||||||
Usage
|
|
||||||
-----
|
|
||||||
|
|
||||||
```bash
|
|
||||||
|
|
||||||
# Add the stock NodeJS env to your Fission deployment
|
|
||||||
$ fission env create --name nodejs --image fission/node-env
|
|
||||||
|
|
||||||
# A javascript one-liner that prints "hello world"
|
|
||||||
$ curl https://raw.githubusercontent.com/fission/fission/master/examples/nodejs/hello.js > hello.js
|
|
||||||
|
|
||||||
# Upload your function code to fission
|
|
||||||
$ fission function create --name hello --env nodejs --code hello.js
|
|
||||||
|
|
||||||
# Map GET /hello to your new function
|
|
||||||
$ fission route create --method GET --url /hello --function hello
|
|
||||||
|
|
||||||
# Run the function. This takes about 100msec the first time.
|
|
||||||
$ fission function test --name hello
|
|
||||||
Hello, world!
|
|
||||||
```
|
|
||||||
|
|
||||||
See the [examples](examples) directory for more.
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Fission Concepts"
|
|
||||||
chapter: true
|
|
||||||
draft: false
|
|
||||||
weight: 30
|
|
||||||
---
|
|
||||||
|
|
||||||
# Fission Concepts
|
|
||||||
|
|
||||||
This is an overview of the few main concepts in Fission: Functions,
|
|
||||||
Environments, and Triggers.
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Environments"
|
|
||||||
draft: false
|
|
||||||
weight: 32
|
|
||||||
---
|
|
||||||
|
|
||||||
An environment contains the language and runtime specific parts of a function. An environment is essentially a container with a webserver and a dynamic loader for the function code.
|
|
||||||
|
|
||||||
The following pre-built environments are currently available for use in Fission:
|
|
||||||
|
|
||||||
| Environment | Image |
|
|
||||||
| ------------------------------------ | ------------------------- |
|
|
||||||
| Binary (for executables or scripts) | `fission/binary-env` |
|
|
||||||
| Go | `fission/go-env` |
|
|
||||||
| .NET | `fission/dotnet-env` |
|
|
||||||
| .NET 2.0 | `fission/dotnet20-env` |
|
|
||||||
| NodeJS (Alpine) | `fission/node-env` |
|
|
||||||
| NodeJS (Debian) | `fission/node-env-debian` |
|
|
||||||
| Perl | `fission/perl-env` |
|
|
||||||
| PHP 7 | `fission/php-env` |
|
|
||||||
| Python 3 | `fission/python-env` |
|
|
||||||
| Ruby | `fission/ruby-env` |
|
|
||||||
|
|
||||||
To create custom environments you can extend one of the environments in the list or create your own environment from scratch.
|
|
||||||
@@ -1,39 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Controlling Function Execution"
|
|
||||||
draft: false
|
|
||||||
weight: 33
|
|
||||||
---
|
|
||||||
# Executors
|
|
||||||
|
|
||||||
When you create a function, you can specify an executor for a function. An executor controls how function pods are created and what capabilities are available for that executor type.
|
|
||||||
|
|
||||||
## Pool-based executor
|
|
||||||
|
|
||||||
A pool based executor (Refered to as poolmgr) creates a pool of generic environment pods as soon as you create an environment. The pool size of initial "warm" containers can be configured based on user needs. These warm containers contain a small dynamic loader for loading the function. Resource requirements are specified at environment level and are inherited by specialized function pods.
|
|
||||||
|
|
||||||
Once you create a function and invoke it, one of pods from the pool is taken out and "specialized" and used for execution. This pod is used for subseqnent requests for that function. If there are no more requests for a certain idle duration, then this pod is cleaned up. If a new requests come after the earlier specialized pod was cleaned up, then a new pod is specialised from the pool and used for execution.
|
|
||||||
|
|
||||||
Poolmgr executortype is great for functions where lower latency is a requirement. Poolmgr executortype has certain limitations: for example, you can not autoscale them based on demand.
|
|
||||||
|
|
||||||
|
|
||||||
## New-deployment executor
|
|
||||||
|
|
||||||
New-Deployment executor (Newdeploy) creates a Kubernetes Deployment along with a Service and HorizontalPodAutoscaler for function execution. This enables autoscaling of function pods and load balancing the requests between pods. In future additional capabilities will be added for newdeploy executortype such as support for volume etc. In the new-deploy executor, resource requirements can be specified at the function level. These requirements override those specified in the environment.
|
|
||||||
|
|
||||||
Newdeploy executortype can be used for requests with no particular low-latency requirements, such as those invoked asynchronously, minscale can be set to zero. In this case the Kubernetes deployment and other objects will be created on first invocation of the function. Subsequent requests can be served by the same deployment. If there are no requests for certain duration then the idle objects are cleaned up. This mechanism ensures resource consumption only on demand and is a good fit for asynchronous requests.
|
|
||||||
|
|
||||||
For requests where latency requirements are stringent, a minscale greater than zero can be set. This essentially keeps a minscale number of pods ready when you create a function. When the function is invoked, there is no delay since the pod is already created. Also minscale ensures that the pods are not cleaned up even if the function is idle. This is great for functions where lower latency is more important than saving resource consumption when functions are idle.
|
|
||||||
|
|
||||||
### The latency vs. idle-cost tradeoff
|
|
||||||
|
|
||||||
The executors allow you as a user to decide between latency and a small idle cost tradeoff. Depending on the need you can choose one of the combinations which is optimal for your use case. In future, a more intelligent dispatch mechanism will enable more complex combinations of executors.
|
|
||||||
|
|
||||||
| Executor Type | Min Scale| Latency | Idle cost |
|
|
||||||
|:---------|:---------:|:---------:|:---------|
|
|
||||||
|Newdeploy|0|High|Very low - pods get cleaned up after idlle time|
|
|
||||||
|Newdeploy|>0|Low|Medium, Min Scale number of pods are always up|
|
|
||||||
|Poolmgr|0|Low|Low, pool of pods are always up|
|
|
||||||
|
|
||||||
### Autoscaling
|
|
||||||
|
|
||||||
The new deployment based executor provides autoscaling for functions based on CPU usage. In future custom metrics will be also supported for scaling the functions. You can set the intial and maximum CPU for a function and target CPU at which autoscaling will be trigerred. Autoscaling is useful for workloads where you expect intermittant spikes in workloads. It also enables optimal usage of resources to execute functions, by using a baseline capacity with minimum scale and ability to burst up to maximum scale based on spikes in demand.
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Function"
|
|
||||||
draft: true
|
|
||||||
weight: 31
|
|
||||||
---
|
|
||||||
A function is a piece of code that will be invoked based on a [trigger](../trigger). The code follows the Fission interface. In practice, the function is only an entry point for execution and it can be backed by a larger program or module.
|
|
||||||
|
|
||||||
A function is registered with Fission through a CLI and associated with a trigger. A function can be created based on a single source file or a source archive or a deployment archive.
|
|
||||||
|
|
||||||
It is possible to associate and use Kubernetes secrets and configmaps with a function.
|
|
||||||
|
|
||||||
Functions also accept minimum and maximum CPU and memory to be assigned, the behaviour of which varies based on executor types which are discussed in greater detail [here](../executor)
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Builder and Packages"
|
|
||||||
draft: false
|
|
||||||
weight: 36
|
|
||||||
---
|
|
||||||
|
|
||||||
Most real world applications are more than a single file of code and typically have dependencies on libraries etc. Packages in fission solve three distinct problems:
|
|
||||||
|
|
||||||
1) Enable a mechanism to store more than one file as a single unit and use them with functions. This is done through a combination of deployment archive builder environment associated with the environment.
|
|
||||||
|
|
||||||
2) Provide a mechanism to build from source code and dependencies into a binary based on a build command and store it as an object. User should be able to use this built artifact with a function. This is achieved with a source archive and a builder environment.
|
|
||||||
|
|
||||||
3) Decouple the execution logic from the functions and thus enable reuse of same logic for multiple functions. This will enable user to run same logic with different functions having different runtime charateristics and executor types.
|
|
||||||
|
|
||||||
When you create a function with a single source file, fission internally creates a package and links it to a function. Creating a package explicitly gives more flexibility in some use cases as explained above.
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Trigger"
|
|
||||||
draft: false
|
|
||||||
weight: 34
|
|
||||||
---
|
|
||||||
|
|
||||||
Triggers are events that can invoke a [function](../function). Fission has three kinds of triggers that can be used to invoke functions.
|
|
||||||
|
|
||||||
## Http Trigger
|
|
||||||
|
|
||||||
HTTP triggers enable calling functions with HTTP requests. Supported methods are GET, POST, PUT, DELETE, HEAD and by default GET is used. URL pattern follow the gorilla/mux supported patterns.
|
|
||||||
|
|
||||||
## Time Trigger
|
|
||||||
|
|
||||||
If you want a function to be called at a periodic frequency then the time triggers are perfect for the use case. Time triggers follow cron like specifications and are invoked based on the cron schedule.
|
|
||||||
|
|
||||||
Time trigger based invocations are great for running scheduled jobs, periodic cleanup jobs, periodic polling based invocations etc.
|
|
||||||
|
|
||||||
## MQ Trigger
|
|
||||||
|
|
||||||
Message queue based trigger enables ability to listen on a topic and invoke a function for each message. You can optinally send a response to another topic. By default it is assumed that the messages in queue are in application/json format but you can specify otherwise while creating the trigger. Currently `nats-streaming` and `azure-storage-queue` are supported message queues supported.
|
|
||||||
|
|
||||||
MQ triggers are great for integrating various systems in a decoupled and asynchronous manner.
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Contributing to Fission"
|
|
||||||
draft: false
|
|
||||||
weight: 50
|
|
||||||
chapter: true
|
|
||||||
---
|
|
||||||
|
|
||||||
# Contributing to Fission
|
|
||||||
|
|
||||||
### Development guide
|
|
||||||
@@ -1,56 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Compiling Fission"
|
|
||||||
date: 2017-09-07T20:10:05-07:00
|
|
||||||
draft: false
|
|
||||||
weight: 51
|
|
||||||
---
|
|
||||||
|
|
||||||
[You only need to do this if you're making Fission changes; if you're
|
|
||||||
just deploying Fission, use fission.yaml which points to prebuilt
|
|
||||||
images.]
|
|
||||||
|
|
||||||
You'll need the `go` compiler and tools installed, along with the
|
|
||||||
[glide dependency management
|
|
||||||
tool](https://github.com/Masterminds/glide#install). You'll also need
|
|
||||||
docker for building images.
|
|
||||||
|
|
||||||
The server side is compiled as one binary ("fission-bundle") which
|
|
||||||
contains controller, poolmgr and router; it invokes the right one
|
|
||||||
based on command-line arguments.
|
|
||||||
|
|
||||||
To build fission-bundle: clone this repo to
|
|
||||||
`$GOPATH/src/github.com/fission/fission`, then from the top level
|
|
||||||
directory (if you want to build the image with the docker inside
|
|
||||||
minikube, you'll need to set the proper environment variables with
|
|
||||||
`eval $(minikube docker-env)`):
|
|
||||||
|
|
||||||
```
|
|
||||||
# Get dependencies
|
|
||||||
$ glide install
|
|
||||||
|
|
||||||
# Build fission server and an image
|
|
||||||
$ pushd fission-bundle
|
|
||||||
$ ./build.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
You now need to build the docker image for fission. You can use
|
|
||||||
`push.sh` and push it to a docker hub account. But it's easiest to use
|
|
||||||
minikube and its built-in docker daemon:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ eval $(minikube docker-env)
|
|
||||||
$ docker build -t minikube/fission-bundle .
|
|
||||||
```
|
|
||||||
|
|
||||||
Next, install fission with this image on your kubernetes cluster using the helm chart:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ helm install --set "image=minikube/fission-bundle,pullPolicy=IfNotPresent,analytics=false" charts/fission-all
|
|
||||||
```
|
|
||||||
|
|
||||||
And if you're changing the CLI too, you can build it with:
|
|
||||||
|
|
||||||
```
|
|
||||||
# Build Fission CLI
|
|
||||||
$ cd fission && go install
|
|
||||||
```
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Installation Guide"
|
|
||||||
draft: false
|
|
||||||
weight: 20
|
|
||||||
chapter : true
|
|
||||||
---
|
|
||||||
|
|
||||||
# Installation
|
|
||||||
|
|
||||||
### Installing and upgrading Fission
|
|
||||||
@@ -1,157 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Installation Guide"
|
|
||||||
draft: false
|
|
||||||
weight: 20
|
|
||||||
---
|
|
||||||
|
|
||||||
Welcome! This guide will get you up and running with Fission on a
|
|
||||||
Kubernetes cluster.
|
|
||||||
|
|
||||||
### Cluster preliminaries
|
|
||||||
|
|
||||||
If you don't have a Kubernetes cluster, [here's a quick guide to set
|
|
||||||
one up](../kubernetessetup).
|
|
||||||
|
|
||||||
Let's ensure you have the Kubernetes CLI and Helm installed and
|
|
||||||
ready. If you already have helm, [skip ahead to the fission install](#install-fission).
|
|
||||||
|
|
||||||
#### Kubernetes CLI
|
|
||||||
|
|
||||||
Ensure you have the Kubernetes CLI.
|
|
||||||
|
|
||||||
You can get the Kubernetes CLI for OSX like this:
|
|
||||||
```sh
|
|
||||||
$ curl -LO https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/darwin/amd64/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin
|
|
||||||
```
|
|
||||||
|
|
||||||
Or, for Linux:
|
|
||||||
```sh
|
|
||||||
$ curl -LO https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/linux/amd64/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin
|
|
||||||
```
|
|
||||||
|
|
||||||
Ensure you have access to a cluster; use kubectl to check your
|
|
||||||
Kubernetes version:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
$ kubectl version
|
|
||||||
```
|
|
||||||
|
|
||||||
We need at least Kubernetes 1.6 (older versions may work, but we don't
|
|
||||||
test them).
|
|
||||||
|
|
||||||
#### Helm
|
|
||||||
|
|
||||||
Helm is an installer for Kubernetes. If you already use helm, [skip to
|
|
||||||
the next section](#install-fission).
|
|
||||||
|
|
||||||
First, you'll need the helm CLI:
|
|
||||||
|
|
||||||
On __OS X__:
|
|
||||||
```sh
|
|
||||||
$ curl -LO https://storage.googleapis.com/kubernetes-helm/helm-v2.7.0-darwin-amd64.tar.gz
|
|
||||||
|
|
||||||
$ tar xzf helm-v2.7.0-darwin-amd64.tar.gz
|
|
||||||
|
|
||||||
$ mv darwin-amd64/helm /usr/local/bin
|
|
||||||
```
|
|
||||||
|
|
||||||
On __Linux__:
|
|
||||||
```sh
|
|
||||||
$ curl -LO https://storage.googleapis.com/kubernetes-helm/helm-v2.7.0-linux-amd64.tar.gz
|
|
||||||
|
|
||||||
$ tar xzf helm-v2.7.0-linux-amd64.tar.gz
|
|
||||||
|
|
||||||
$ mv linux-amd64/helm /usr/local/bin
|
|
||||||
```
|
|
||||||
|
|
||||||
Next, install the Helm server on your Kubernetes cluster:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
$ helm init
|
|
||||||
```
|
|
||||||
|
|
||||||
### Install Fission
|
|
||||||
|
|
||||||
#### Minikube
|
|
||||||
|
|
||||||
```sh
|
|
||||||
$ helm install --namespace fission --set serviceType=NodePort https://github.com/fission/fission/releases/download/0.6.0/fission-all-0.6.0.tgz
|
|
||||||
```
|
|
||||||
|
|
||||||
The serviceType variable allows configuring the type of Kubernetes
|
|
||||||
service outside the cluster. You can use `ClusterIP` if you don't
|
|
||||||
want to expose anything outside the cluster.
|
|
||||||
|
|
||||||
#### Cloud hosted clusters (GKE, AWS, Azure etc.)
|
|
||||||
|
|
||||||
```sh
|
|
||||||
$ helm install --namespace fission https://github.com/fission/fission/releases/download/0.6.0/fission-all-0.6.0.tgz
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Minimal version
|
|
||||||
|
|
||||||
The fission-all helm chart installs a full set of services including
|
|
||||||
the NATS message queue, influxDB for logs, etc. If you want a more
|
|
||||||
minimal setup, you can install the fission-core chart instead:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
$ helm install --namespace fission https://github.com/fission/fission/releases/download/0.6.0/fission-core-0.6.0.tgz
|
|
||||||
```
|
|
||||||
|
|
||||||
### Install the Fission CLI
|
|
||||||
|
|
||||||
#### OS X
|
|
||||||
|
|
||||||
Get the CLI binary for Mac:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
$ curl -Lo fission https://github.com/fission/fission/releases/download/0.6.0/fission-cli-osx && chmod +x fission && sudo mv fission /usr/local/bin/
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Linux
|
|
||||||
|
|
||||||
```sh
|
|
||||||
$ curl -Lo fission https://github.com/fission/fission/releases/download/0.6.0/fission-cli-linux && chmod +x fission && sudo mv fission /usr/local/bin/
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Windows
|
|
||||||
|
|
||||||
For Windows, you can use the linux binary on WSL. Or you can download
|
|
||||||
this windows executable: [fission.exe](https://github.com/fission/fission/releases/download/0.6.0/fission-cli-windows.exe)
|
|
||||||
|
|
||||||
### Run an example
|
|
||||||
|
|
||||||
Finally, you're ready to use Fission!
|
|
||||||
|
|
||||||
```sh
|
|
||||||
$ fission env create --name nodejs --image fission/node-env:0.6.0
|
|
||||||
|
|
||||||
$ curl -LO https://raw.githubusercontent.com/fission/fission/master/examples/nodejs/hello.js
|
|
||||||
|
|
||||||
$ fission function create --name hello --env nodejs --code hello.js
|
|
||||||
|
|
||||||
$ fission function test --name hello
|
|
||||||
Hello, world!
|
|
||||||
```
|
|
||||||
|
|
||||||
For a compiled language like Go:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
$ fission env create --name go --image fission/go-env:0.6.0 --builder fission/go-builder:0.6.0
|
|
||||||
|
|
||||||
$ curl -LO https://raw.githubusercontent.com/fission/fission/master/examples/go/hello.go
|
|
||||||
|
|
||||||
$ fission function create --name gohello --env go --src hello.go --entrypoint Handler
|
|
||||||
|
|
||||||
$ fission function test --name gohello
|
|
||||||
Hello, world!
|
|
||||||
```
|
|
||||||
|
|
||||||
### What's next?
|
|
||||||
|
|
||||||
If something went wrong, we'd love to help -- please [drop by the
|
|
||||||
slack channel](http://slack.fission.io) and ask for help.
|
|
||||||
|
|
||||||
Check out the
|
|
||||||
[examples](https://github.com/fission/fission/tree/master/examples)
|
|
||||||
for some example functions.
|
|
||||||
@@ -1,41 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Kubernetes Quick Install"
|
|
||||||
draft: false
|
|
||||||
weight: 21
|
|
||||||
---
|
|
||||||
|
|
||||||
This is a quick guide to help you get started running Kubernetes on
|
|
||||||
your laptop (or on the cloud).
|
|
||||||
|
|
||||||
(This isn't meant as a production Kuberenetes guide; it's merely
|
|
||||||
intended to give you something quickly so you can try Fission on it.)
|
|
||||||
|
|
||||||
## Minikube
|
|
||||||
|
|
||||||
Minikube is the usual way to run Kubernetes on your laptop:
|
|
||||||
|
|
||||||
### Install and start Kubernetes on OSX:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ curl -LO https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/darwin/amd64/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin
|
|
||||||
|
|
||||||
$ curl -Lo minikube https://storage.googleapis.com/minikube/releases/v0.16.0/minikube-darwin-amd64 && chmod +x minikube && sudo mv minikube /usr/local/bin/
|
|
||||||
|
|
||||||
$ minikube start
|
|
||||||
```
|
|
||||||
|
|
||||||
### Or, install and start Kubernetes on Linux:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ curl -LO https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/linux/amd64/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin
|
|
||||||
|
|
||||||
$ curl -Lo minikube https://storage.googleapis.com/minikube/releases/v0.16.0/minikube-linux-amd64 && chmod +x minikube && sudo mv minikube /usr/local/bin/
|
|
||||||
|
|
||||||
$ minikube start
|
|
||||||
```
|
|
||||||
|
|
||||||
## Google Container Engine
|
|
||||||
|
|
||||||
Alternatively, you can use [Google Container Engine's](https://cloud.google.com/container-engine/) free trial to
|
|
||||||
get a 3-node cluster. Hop over to [Google Cloud](https://cloud.google.com/container-engine/) to set that up.
|
|
||||||
|
|
||||||
@@ -1,53 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Release notes"
|
|
||||||
draft: false
|
|
||||||
weight: 22
|
|
||||||
---
|
|
||||||
|
|
||||||
- The fission team is on http://slack.fission.io if you have any questions.
|
|
||||||
|
|
||||||
### 0.4.0
|
|
||||||
|
|
||||||
- This release is compatible with Kubernetes 1.7 onwards.
|
|
||||||
- We switched from ThirdPartyResources to CustomResourceDefinitions. ThirdPartyResources are removed in Kubernetes 1.8, so upgrade with caution, using the upgrade guide below.
|
|
||||||
- Upgrade guides:
|
|
||||||
- [Upgrade guide from 0.3.0](../upgrade/upgrade-from-v0.3)
|
|
||||||
- To upgrade from 0.2.1, please upgrade to 0.3.0 first, following the upgrade guide in the 0.3.0 release.
|
|
||||||
|
|
||||||
### 0.3.0
|
|
||||||
|
|
||||||
Note: This release is incompatible with Kubernetes 1.8 (Because it uses ThirdPartyResources; see #314)
|
|
||||||
|
|
||||||
This release introduces:
|
|
||||||
|
|
||||||
- Build pipeline. Currently, only the Python environment supports this.
|
|
||||||
- Workflow engine support (compatible with fission-workflows 0.1.1)
|
|
||||||
|
|
||||||
### v0.2.1
|
|
||||||
|
|
||||||
Lots of big changes in this release!
|
|
||||||
|
|
||||||
- Most importantly, the API has changed a lot. We switched to Kubernetes
|
|
||||||
ThirdPartyResources, and improved various pieces of the API to support
|
|
||||||
new environments.
|
|
||||||
|
|
||||||
- The old API was too different from widely used Kubernetes patterns,
|
|
||||||
and so we decided to fully break compatibility for this release. We're still in
|
|
||||||
alpha, so you should expect the occasional API breakage; we'll be
|
|
||||||
better at preserving compatibility once we reach beta.
|
|
||||||
|
|
||||||
- The CLI is still compatible. Environments are also still compatible --
|
|
||||||
environment images that worked before continue to work.
|
|
||||||
|
|
||||||
- We're creating an upgrade tool to help migrate; if you're upgrading
|
|
||||||
v0.1.0 and can't do a fresh install, wait for the upgrade tool.
|
|
||||||
|
|
||||||
- We now use Helm for installation instead of a set of YAML files.
|
|
||||||
|
|
||||||
- The Fission "controller" is now stateless. Fission's etcd deployment
|
|
||||||
is removed, since Fission stores state in ThirdPartyResources. Large
|
|
||||||
function files are stored in a new function storage service, which
|
|
||||||
uses a persistent volume.
|
|
||||||
|
|
||||||
- And, we've started a new docs site; for now it's just the installation
|
|
||||||
and upgrade guides, but we'll be writing more docs soon.
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Upgrade"
|
|
||||||
weight: 30
|
|
||||||
---
|
|
||||||
|
|
||||||
### From v0.4.x to v0.5.0
|
|
||||||
* [Upgrade guide](upgrade-from-v0.4)
|
|
||||||
|
|
||||||
### From v0.3 to v0.4.x
|
|
||||||
* [Upgrade guide](upgrade-from-v0.3)
|
|
||||||
|
|
||||||
### From v0.1 to v0.2.x
|
|
||||||
* [Upgrade guide](upgrade-from-v0.1)
|
|
||||||
@@ -1,117 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Upgrading from v0.1 to v0.2.x"
|
|
||||||
draft: false
|
|
||||||
weight: 31
|
|
||||||
---
|
|
||||||
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
The Fission API has changed significantly in this version. The new API is incompatible with the
|
|
||||||
old one. The CLI is compatible; if you wrote scripts using it, those should still work.
|
|
||||||
|
|
||||||
Below we describe a tool for migrating your state from your old install to the new one.
|
|
||||||
|
|
||||||
While this upgrade is going to be disruptive, we're going to do our best to make sure future
|
|
||||||
upgrades aren't as bad.
|
|
||||||
|
|
||||||
## Why is this so complicated?
|
|
||||||
|
|
||||||
For a couple of reasons, we wanted to switch to using Kubernetes resources (ThirdPartyResources
|
|
||||||
now, CustomResources in the next release) for storing Fission state: (a) it would allow users to
|
|
||||||
avoid management of another database and (b) Fission would fit better into the Kubernetes
|
|
||||||
ecosystem.
|
|
||||||
|
|
||||||
Concurrently with this change, we were also trying to make our versioning approach less
|
|
||||||
opinionated, so it would work with other tools.
|
|
||||||
|
|
||||||
Thirdly, we were also enabling build pipelines (v2 Environments).
|
|
||||||
|
|
||||||
These changes, especially the difference in versioning approach, made maintaining compatiblity not
|
|
||||||
worth the effort at this early stage of the project.
|
|
||||||
|
|
||||||
All that said, we want you to know that we care a lot about compatiblity, and we'll be more
|
|
||||||
rigorous about it from the beta release onwards.
|
|
||||||
|
|
||||||
## How to Upgrade
|
|
||||||
|
|
||||||
1. Get the v0.2.1 CLI
|
|
||||||
1. Get the Fission state from your old install
|
|
||||||
1. Install Fission v0.2.1
|
|
||||||
1. Restore Fission state into your new install
|
|
||||||
1. Destroy your old install
|
|
||||||
|
|
||||||
### Get the new CLI
|
|
||||||
|
|
||||||
#### OS X
|
|
||||||
|
|
||||||
```
|
|
||||||
$ curl -Lo fission https://github.com/fission/fission/releases/download/v0.2.1-rc/fission-cli-osx && chmod +x fission && sudo mv fission /usr/local/bin/
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Linux
|
|
||||||
|
|
||||||
```
|
|
||||||
$ curl -Lo fission https://github.com/fission/fission/releases/download/v0.2.1-rc/fission-cli-linux && chmod +x fission && sudo mv fission /usr/local/bin/
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Windows
|
|
||||||
|
|
||||||
For Windows, you can use the linux binary on WSL. Or you can download
|
|
||||||
this windows executable: [fission.exe](https://github.com/fission/fission/releases/download/v0.2.1-rc/fission-cli-windows.exe)
|
|
||||||
|
|
||||||
### Get Fission state from v0.1 install
|
|
||||||
|
|
||||||
```
|
|
||||||
fission --server <your V1 server> upgrade dump --file state.json
|
|
||||||
```
|
|
||||||
|
|
||||||
You can skip the --server argument if you have the environment
|
|
||||||
variable `$FISSION_URL` set to point at a v0.1 Fission server.
|
|
||||||
|
|
||||||
This will create a JSON file with all your fission state in the
|
|
||||||
current directory.
|
|
||||||
|
|
||||||
### Install the new version
|
|
||||||
|
|
||||||
Read the [install guide](../install). You can follow all of it, except that you will need to
|
|
||||||
ensure your two installs don't conflict. To do that, use separate namespaces and ensure nodeports
|
|
||||||
don't conflict. Install with a command similar to this:
|
|
||||||
|
|
||||||
```
|
|
||||||
helm install fission-all --namespace fission2 --set controllerPort=31303,routerPort=31304,natsStreamingPort=31305,functionNamespace=fission2-function
|
|
||||||
```
|
|
||||||
|
|
||||||
This installs fission in the `fission2` namespace and runs functions
|
|
||||||
in the `fission2-function` namespace.
|
|
||||||
|
|
||||||
### Restore your Fission state into Fission v0.2.1
|
|
||||||
|
|
||||||
```
|
|
||||||
fission upgrade restore --file state.json
|
|
||||||
```
|
|
||||||
|
|
||||||
This commands needs $FISSION_URL set to point to new fission installation.
|
|
||||||
|
|
||||||
It uses the file created in the first step. It doesn't modify state.json.
|
|
||||||
|
|
||||||
(Note that you can run this restore on any cluster; it doesn't have the be the same kubernetes
|
|
||||||
cluster as your old install.)
|
|
||||||
|
|
||||||
### Verify
|
|
||||||
|
|
||||||
How exactly you do this is up to you! But, at a minimum, run `fission
|
|
||||||
fn list` to check that all the functions you expect are there.
|
|
||||||
|
|
||||||
### Switch over
|
|
||||||
|
|
||||||
If you had exposed fission's router to the outside world, switch over to using the new install's router.
|
|
||||||
|
|
||||||
### Destroy your old install
|
|
||||||
|
|
||||||
Once you're no longer using the old install, you can destroy it by
|
|
||||||
deleting the namespaces that was installed in.
|
|
||||||
|
|
||||||
```
|
|
||||||
kubectl delete namespace fission fission-function
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,131 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Upgrading from v0.3 to v0.4.x"
|
|
||||||
draft: false
|
|
||||||
weight: 32
|
|
||||||
---
|
|
||||||
|
|
||||||
## Introduction
|
|
||||||
|
|
||||||
Kubernetes ThirdPartyResources ("TPR") are replaced by
|
|
||||||
CustomResourceDefinitions ("CRD"). TPRs have been deprecated and are
|
|
||||||
removed in Kubernetes 1.8.
|
|
||||||
|
|
||||||
Since Fission stores state in TPRs, we need to migrate this state from
|
|
||||||
TPRs to CRDs while upgrading.
|
|
||||||
|
|
||||||
Follow the instructions below if you're upgrading a Fission 0.2.1 or
|
|
||||||
0.3.0 cluster to 0.4. If you're using a pre-0.2 Fission cluster, use
|
|
||||||
the [upgrade guide from 0.1 to 0.2]() and then upgrade to 0.4.0.
|
|
||||||
|
|
||||||
## How to Upgrade
|
|
||||||
|
|
||||||
1. Get the 0.4.0 CLI
|
|
||||||
2. Get the Fission state from v0.3 install
|
|
||||||
3. Upgrade to Fission 0.4.0
|
|
||||||
4. Upgrade Kubernetes cluster version to 1.7.x or higher
|
|
||||||
5. Remove all TPR definition (for Kubernetes 1.7.x)
|
|
||||||
6. Restore Fission state into CRDs
|
|
||||||
|
|
||||||
### Get the new CLI
|
|
||||||
|
|
||||||
#### OS X
|
|
||||||
|
|
||||||
```
|
|
||||||
$ curl -Lo fission https://github.com/fission/fission/releases/download/0.4.0/fission-cli-osx && chmod +x fission && sudo mv fission /usr/local/bin/
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Linux
|
|
||||||
|
|
||||||
```
|
|
||||||
$ curl -Lo fission https://github.com/fission/fission/releases/download/0.4.0/fission-cli-linux && chmod +x fission && sudo mv fission /usr/local/bin/
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Windows
|
|
||||||
|
|
||||||
For Windows, you can use the linux binary on WSL. Or you can download
|
|
||||||
this windows executable: [fission.exe](https://github.com/fission/fission/releases/download/0.4.0/fission-cli-windows.exe)
|
|
||||||
|
|
||||||
### Get Fission state from v0.3 install
|
|
||||||
|
|
||||||
```
|
|
||||||
fission --server <your v0.3 server> tpr2crd dump --file state.json
|
|
||||||
```
|
|
||||||
|
|
||||||
You can skip the --server argument if you have the environment
|
|
||||||
variable `$FISSION_URL` set to point at a v0.3 Fission server.
|
|
||||||
|
|
||||||
This will create a JSON file with all your fission state in the
|
|
||||||
current directory.
|
|
||||||
|
|
||||||
### Upgrade to Fission 0.4.0
|
|
||||||
|
|
||||||
Upgrade fission with a command similar to this:
|
|
||||||
|
|
||||||
```
|
|
||||||
helm upgrade fission-all --namespace fission
|
|
||||||
```
|
|
||||||
|
|
||||||
### Upgrade Kubernetes cluster version
|
|
||||||
|
|
||||||
Since CustomResource is only supported on Kubernetes v1.7+ and higher, please make sure
|
|
||||||
that you upgrade to the right version that supports CustomResource.
|
|
||||||
|
|
||||||
### Remove all TPR definition (for Kubernetes 1.7.x)
|
|
||||||
|
|
||||||
** NOTICE **: This step will remove TPR definition from your kubernetes cluster. Please make sure that you dump all TPRs at the second step!
|
|
||||||
|
|
||||||
Though Kubernetes will migrate TPRs to CRDs automatically when TPR definition is deleted if the same name CRD exists. We still need to make sure that there is no resource gets lost during the migration. Also, since we changed the capitalization of some CRDs to CamelCase (e.g. Httptrigger -> HTTPTrigger), we need to recreate those resources by ourselves.
|
|
||||||
|
|
||||||
```
|
|
||||||
fission tpr2crd delete
|
|
||||||
```
|
|
||||||
|
|
||||||
### Restore your Fission state into Fission 0.4.0
|
|
||||||
|
|
||||||
```
|
|
||||||
fission tpr2crd restore --file state.json
|
|
||||||
```
|
|
||||||
|
|
||||||
This commands needs `$FISSION_URL` set to point to new fission installation.
|
|
||||||
|
|
||||||
It uses the file created in the first step. It doesn't modify state.json.
|
|
||||||
|
|
||||||
(Note that you can run this restore on any cluster; it doesn't have the be the same kubernetes
|
|
||||||
cluster as your old install.)
|
|
||||||
|
|
||||||
### Verify
|
|
||||||
|
|
||||||
Let's check the migration result, first run following command to check CRD established state.
|
|
||||||
|
|
||||||
```
|
|
||||||
kubectl get crd -o 'custom-columns=NAME:{.metadata.name},ESTABLISHED:{.status.conditions[?(@.type=="Established")].status}'
|
|
||||||
```
|
|
||||||
|
|
||||||
The output should be like this
|
|
||||||
|
|
||||||
```
|
|
||||||
NAME ESTABLISHED
|
|
||||||
environments.fission.io True
|
|
||||||
functions.fission.io True
|
|
||||||
httptriggers.fission.io True
|
|
||||||
kuberneteswatchtriggers.fission.io True
|
|
||||||
messagequeuetriggers.fission.io True
|
|
||||||
packages.fission.io True
|
|
||||||
timetriggers.fission.io True
|
|
||||||
```
|
|
||||||
|
|
||||||
And check that CRD resources you expect are there.
|
|
||||||
|
|
||||||
```
|
|
||||||
COMMAND:
|
|
||||||
fission [resource] list
|
|
||||||
|
|
||||||
RESOURCES:
|
|
||||||
environments
|
|
||||||
functions
|
|
||||||
httptriggers
|
|
||||||
kuberneteswatchtriggers
|
|
||||||
messagequeuetriggers
|
|
||||||
packages
|
|
||||||
timetriggers
|
|
||||||
```
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Upgrading from v0.4.x to v0.5.0"
|
|
||||||
draft: false
|
|
||||||
weight: 33
|
|
||||||
---
|
|
||||||
|
|
||||||
## How to Upgrade
|
|
||||||
|
|
||||||
1. Get the 0.5.0 CLI
|
|
||||||
2. Upgrade to Fission 0.5.0
|
|
||||||
|
|
||||||
### Get the new CLI
|
|
||||||
|
|
||||||
#### OS X
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ curl -Lo fission https://github.com/fission/fission/releases/download/0.5.0/fission-cli-osx && chmod +x fission && sudo mv fission /usr/local/bin/
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Linux
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ curl -Lo fission https://github.com/fission/fission/releases/download/0.5.0/fission-cli-linux && chmod +x fission && sudo mv fission /usr/local/bin/
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Windows
|
|
||||||
|
|
||||||
For Windows, you can use the linux binary on WSL. Or you can download
|
|
||||||
this windows executable: [fission.exe](https://github.com/fission/fission/releases/download/0.5.0/fission-cli-windows.exe)
|
|
||||||
|
|
||||||
### Upgrade to Fission 0.5.0
|
|
||||||
|
|
||||||
Upgrade fission with a command similar to this:
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
# find the release want to upgrade
|
|
||||||
$ helm list
|
|
||||||
|
|
||||||
# upgrade to 0.5.0
|
|
||||||
$ helm upgrade <release_name> https://github.com/fission/fission/releases/download/0.5.0/fission-all-0.5.0.tgz
|
|
||||||
```
|
|
||||||
@@ -1,203 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Enabling Istio on Fission"
|
|
||||||
draft: false
|
|
||||||
weight: 42
|
|
||||||
---
|
|
||||||
|
|
||||||
This is the very first step for fission to integrate with [Istio](https://istio.io/). For those interested in trying to integrate fission with istio, following is the set up tutorial.
|
|
||||||
|
|
||||||
## Test Environment
|
|
||||||
* Google Kubernetes Engine: 1.9.2-gke.1
|
|
||||||
|
|
||||||
## Set Up
|
|
||||||
### Create Kubernetes v1.9+ cluster
|
|
||||||
|
|
||||||
Enable both RBAC & initializer features on kubernetes cluster.
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ export ZONE=<zone name>
|
|
||||||
$ gcloud container clusters create istio-demo-1 \
|
|
||||||
--machine-type=n1-standard-2 \
|
|
||||||
--num-nodes=1 \
|
|
||||||
--no-enable-legacy-authorization \
|
|
||||||
--zone=$ZONE \
|
|
||||||
--cluster-version=1.9.2-gke.1
|
|
||||||
```
|
|
||||||
|
|
||||||
### Grant cluster admin permissions
|
|
||||||
|
|
||||||
Grant admin permission for `system:serviceaccount:kube-system:default` and current user.
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
# for system:serviceaccount:kube-system:default
|
|
||||||
$ kubectl create clusterrolebinding --user system:serviceaccount:kube-system:default kube-system-cluster-admin --clusterrole cluster-admin
|
|
||||||
|
|
||||||
# for current user
|
|
||||||
$ kubectl create clusterrolebinding cluster-admin-binding --clusterrole=cluster-admin --user=$(gcloud config get-value core/account)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Set up Istio environment
|
|
||||||
|
|
||||||
For Istio 0.5.1 you can follow the installation tutorial below. Also, you can follow the latest installation guides on Istio official site: [Quick Start](https://istio.io/docs/setup/kubernetes/quick-start.html) and [Sidecar Injection](https://istio.io/docs/setup/kubernetes/sidecar-injection.html).
|
|
||||||
|
|
||||||
|
|
||||||
Download Istio 0.5.1
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ export ISTIO_VERSION=0.5.1
|
|
||||||
$ curl -L https://git.io/getLatestIstio | sh -
|
|
||||||
$ cd istio-0.5.1
|
|
||||||
```
|
|
||||||
|
|
||||||
Apply istio related YAML files
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ kubectl apply -f install/kubernetes/istio.yaml
|
|
||||||
```
|
|
||||||
|
|
||||||
Automatic sidecar injection
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ kubectl api-versions | grep admissionregistration
|
|
||||||
admissionregistration.k8s.io/v1beta1
|
|
||||||
```
|
|
||||||
|
|
||||||
Installing the webhook
|
|
||||||
|
|
||||||
Download the missing files in istio release 0.5.1
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ wget https://raw.githubusercontent.com/istio/istio/master/install/kubernetes/webhook-create-signed-cert.sh -P install/kubernetes/
|
|
||||||
$ wget https://raw.githubusercontent.com/istio/istio/master/install/kubernetes/webhook-patch-ca-bundle.sh -P install/kubernetes/
|
|
||||||
$ chmod +x install/kubernetes/webhook-create-signed-cert.sh install/kubernetes/webhook-patch-ca-bundle.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
Install the sidecar injection configmap.
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ ./install/kubernetes/webhook-create-signed-cert.sh \
|
|
||||||
--service istio-sidecar-injector \
|
|
||||||
--namespace istio-system \
|
|
||||||
--secret sidecar-injector-certs
|
|
||||||
|
|
||||||
$ kubectl apply -f install/kubernetes/istio-sidecar-injector-configmap-release.yaml
|
|
||||||
```
|
|
||||||
|
|
||||||
Install the sidecar injector
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ cat install/kubernetes/istio-sidecar-injector.yaml | \
|
|
||||||
./install/kubernetes/webhook-patch-ca-bundle.sh > \
|
|
||||||
install/kubernetes/istio-sidecar-injector-with-ca-bundle.yaml
|
|
||||||
|
|
||||||
$ kubectl apply -f install/kubernetes/istio-sidecar-injector-with-ca-bundle.yaml
|
|
||||||
|
|
||||||
# Check sidecar injector status
|
|
||||||
$ kubectl -n istio-system get deployment -listio=sidecar-injector
|
|
||||||
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
|
|
||||||
istio-sidecar-injector 1 1 1 1 26s
|
|
||||||
```
|
|
||||||
|
|
||||||
### Install fission
|
|
||||||
|
|
||||||
Set default namespace for helm installation, here we use `fission` as example namespace.
|
|
||||||
``` bash
|
|
||||||
$ export FISSION_NAMESPACE=fission
|
|
||||||
```
|
|
||||||
|
|
||||||
Create namespace & add label for Istio sidecar injection.
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ kubectl create namespace $FISSION_NAMESPACE
|
|
||||||
$ kubectl label namespace $FISSION_NAMESPACE istio-injection=enabled
|
|
||||||
$ kubectl config set-context $(kubectl config current-context) --namespace=$FISSION_NAMESPACE
|
|
||||||
```
|
|
||||||
|
|
||||||
Follow the [installation guide](../../installation/) to install fission with flag `enableIstio` true.
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ helm install --namespace $FISSION_NAMESPACE --set enableIstio=true --name istio-demo <chart-fission-all-url>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Create a function
|
|
||||||
|
|
||||||
Set environment
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ export FISSION_URL=http://$(kubectl --namespace fission get svc controller -o=jsonpath='{..ip}')
|
|
||||||
$ export FISSION_ROUTER=$(kubectl --namespace fission get svc router -o=jsonpath='{..ip}')
|
|
||||||
```
|
|
||||||
|
|
||||||
Let's create a simple function with Node.js.
|
|
||||||
|
|
||||||
``` js
|
|
||||||
# hello.js
|
|
||||||
module.exports = async function(context) {
|
|
||||||
console.log(context.request.headers);
|
|
||||||
return {
|
|
||||||
status: 200,
|
|
||||||
body: "Hello, World!\n"
|
|
||||||
};
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Create environment
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ fission env create --name nodejs --image fission/node-env:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
Create function
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ fission fn create --name h1 --env nodejs --code hello.js --method GET
|
|
||||||
```
|
|
||||||
|
|
||||||
Create route
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ fission route create --method GET --url /h1 --function h1
|
|
||||||
```
|
|
||||||
|
|
||||||
Access function
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ curl http://$FISSION_ROUTER/h1
|
|
||||||
Hello, World!
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### Install Istio Add-ons
|
|
||||||
|
|
||||||
* Prometheus
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ kubectl apply -f istio-0.5.1/install/kubernetes/addons/prometheus.yaml
|
|
||||||
$ kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=prometheus -o jsonpath='{.items[0].metadata.name}') 9090:9090
|
|
||||||
```
|
|
||||||
|
|
||||||
Web Link: [http://127.0.0.1:9090/graph](http://127.0.0.1:9090/graph)
|
|
||||||
|
|
||||||
* Grafana
|
|
||||||
|
|
||||||
Please install Prometheus first.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ kubectl apply -f istio-0.5.1/install/kubernetes/addons/grafana.yaml
|
|
||||||
$ kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=grafana -o jsonpath='{.items[0].metadata.name}') 3000:3000
|
|
||||||
```
|
|
||||||
|
|
||||||
Web Link: [http://127.0.0.1:3000/dashboard/db/istio-dashboard](http://127.0.0.1:3000/dashboard/db/istio-dashboard)
|
|
||||||
|
|
||||||
* Jaegar
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ kubectl apply -n istio-system -f https://raw.githubusercontent.com/jaegertracing/jaeger-kubernetes/master/all-in-one/jaeger-all-in-one-template.yml
|
|
||||||
$ kubectl port-forward -n istio-system $(kubectl get pod -n istio-system -l app=jaeger -o jsonpath='{.items[0].metadata.name}') 16686:16686
|
|
||||||
```
|
|
||||||
|
|
||||||
Web Link: [http://localhost:16686](http://localhost:16686)
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Using Fission"
|
|
||||||
chapter: true
|
|
||||||
draft: false
|
|
||||||
weight: 40
|
|
||||||
---
|
|
||||||
|
|
||||||
# Using Fission
|
|
||||||
|
|
||||||
### Usage guides, tutorials and examples
|
|
||||||
@@ -1,120 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Accessing Secrets in Functions"
|
|
||||||
draft: false
|
|
||||||
weight: 47
|
|
||||||
---
|
|
||||||
|
|
||||||
Functions can access Kubernetes
|
|
||||||
[Secrets](https://kubernetes.io/docs/concepts/configuration/secret/)
|
|
||||||
and
|
|
||||||
[ConfigMaps](https://kubernetes.io/docs/concepts/storage/volumes/#configmap).
|
|
||||||
|
|
||||||
Use secrets for things like API keys, authentication tokens, and so
|
|
||||||
on.
|
|
||||||
|
|
||||||
Use config maps for any other configuration that doesn't need to be a
|
|
||||||
secret.
|
|
||||||
|
|
||||||
### Create A Secret or a ConfigMap
|
|
||||||
|
|
||||||
You can create a Secret or ConfigMap with the Kubernetes CLI:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ kubectl -n default create secret generic my-secret --from-literal=TEST_KEY="TESTVALUE"
|
|
||||||
|
|
||||||
$ kubectl -n default create configmap my-configmap --from-literal=TEST_KEY="TESTVALUE"
|
|
||||||
```
|
|
||||||
|
|
||||||
Or, use `kubectl create -f <filename.yaml>` to create these from a YAML file.
|
|
||||||
|
|
||||||
``` yaml
|
|
||||||
apiVersion: v1
|
|
||||||
kind: Secret
|
|
||||||
metadata:
|
|
||||||
namespace: default
|
|
||||||
name: my-secret
|
|
||||||
data:
|
|
||||||
TEST_KEY: VEVTVFZBTFVF # value after base64 encode
|
|
||||||
type: Opaque
|
|
||||||
|
|
||||||
---
|
|
||||||
apiVersion: v1
|
|
||||||
kind: ConfigMap
|
|
||||||
metadata:
|
|
||||||
namespace: default
|
|
||||||
name: my-configmap
|
|
||||||
data:
|
|
||||||
TEST_KEY: TESTVALUE
|
|
||||||
```
|
|
||||||
|
|
||||||
### Accessing Secrets and ConfigMaps
|
|
||||||
|
|
||||||
Secrets and configmaps are accessed similarly. Each secret or
|
|
||||||
configmap is a set of key value pairs. Fission sets these up as files
|
|
||||||
you can read from your function.
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
# Secret path
|
|
||||||
/secrets/<namespace>/<name>/<key>
|
|
||||||
|
|
||||||
# ConfigMap path
|
|
||||||
/configs/<namespace>/<name>/<key>
|
|
||||||
```
|
|
||||||
|
|
||||||
From the previous example, the paths are:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
# secret my-secret
|
|
||||||
/secrets/default/my-secret/TEST_KEY
|
|
||||||
|
|
||||||
# confimap my-configmap
|
|
||||||
/configs/default/my-configmap/TEST_KEY
|
|
||||||
```
|
|
||||||
|
|
||||||
Now, let's create a simple python function (leaker.py) that returns
|
|
||||||
the value of Secret `my-secret` and ConfigMap `my-configmap`.
|
|
||||||
|
|
||||||
``` python
|
|
||||||
# leaker.py
|
|
||||||
|
|
||||||
def main():
|
|
||||||
path = "/configs/default/my-configmap/TEST_KEY"
|
|
||||||
f = open(path, "r")
|
|
||||||
config = f.read()
|
|
||||||
|
|
||||||
path = "/secrets/default/my-secret/TEST_KEY"
|
|
||||||
f = open(path, "r")
|
|
||||||
secret = f.read()
|
|
||||||
|
|
||||||
msg = "ConfigMap: %s\nSecret: %s" % (config, secret)
|
|
||||||
|
|
||||||
return msg, 200
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
Create an environment and a function:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
# create python env
|
|
||||||
$ fission env create --name python --image fission/python-env
|
|
||||||
|
|
||||||
# create function named "leaker"
|
|
||||||
$ fission fn create --name leaker --env python --code leaker.py --secret my-secret --configmap my-configmap
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
Run the function, and the output should look like this:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ fission function test --name leaker
|
|
||||||
ConfigMap: TESTVALUE
|
|
||||||
Secret: TESTVALUE
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
{{% notice note %}}
|
|
||||||
If the Secret or ConfigMap value is updated, the function may
|
|
||||||
not get the updated value for some time; it may get a cached older
|
|
||||||
value.
|
|
||||||
{{% /notice %}}
|
|
||||||
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Environment"
|
|
||||||
draft: false
|
|
||||||
weight: 42
|
|
||||||
---
|
|
||||||
|
|
||||||
### Create an environment
|
|
||||||
|
|
||||||
You can create an environment on your cluster from an image for that language. Optionally, you can specify CPU and memory resource limits. You can also specify the number of initially pre-warmed pods, which is called the poolsize.
|
|
||||||
|
|
||||||
```
|
|
||||||
$ fission env create --name node --image fission/node-env:0.4.0 --mincpu 40 --maxcpu 80 --minmemory 64 --maxmemory 128 --poolsize 4
|
|
||||||
```
|
|
||||||
|
|
||||||
In case of pool based executor, the resources specified for environment are used for function pod as well. In case of new deployment executor, you can override the resources when you create a function.
|
|
||||||
|
|
||||||
### Using a builder
|
|
||||||
|
|
||||||
When you create an environment, you can specify a builder image and builder command which will be used for building from source code. You can override the build command when creating a function. For more details on builder and packages you should check out examples in [Functions](../functions) and [packages](../package)
|
|
||||||
|
|
||||||
```
|
|
||||||
$ fission env create --name python --image fission/python-env:latest --builder fission/python-builder:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
### Viewing environment information
|
|
||||||
|
|
||||||
You can list the environments or view information of an individual environment:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ fission env list
|
|
||||||
NAME UID IMAGE POOLSIZE MINCPU MAXCPU MINMEMORY MAXMEMORY
|
|
||||||
node ac84d62e-001f-11e8-85c9-42010aa00010 fission/node-env:0.4.0 4 40m 80m 64Mi 128Mi
|
|
||||||
|
|
||||||
$ fission env get --name node
|
|
||||||
NAME UID IMAGE
|
|
||||||
node ac84d62e-001f-11e8-85c9-42010aa00010 fission/node-env:0.4.0
|
|
||||||
```
|
|
||||||
@@ -1,86 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Controlling Function Execution"
|
|
||||||
draft: false
|
|
||||||
weight: 43
|
|
||||||
---
|
|
||||||
|
|
||||||
### Autoscaling
|
|
||||||
|
|
||||||
Let's create a function to demonstrate the autoscaling behaviour in Fission. We create a simple function which outputs "Hello World" in using NodeJS. We have kept the CPU request and limit purposefully low to simulate the load and also kept the target CPU percent to 50%.
|
|
||||||
|
|
||||||
```
|
|
||||||
$ fission fn create --name hello --env node --code hello.js --mincpu 10 --maxcpu 40 --minmemory 64 --maxmemory 128 --minscale 1 --maxscale 6 --executortype newdeploy --targetcpu 50
|
|
||||||
function 'hello' created
|
|
||||||
```
|
|
||||||
|
|
||||||
Now let's use [hey](https://github.com/rakyll/hey) to generate the load with 250 concurrent and a total of 10000 requests:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ hey -c 250 -n 10000 http://$FISSION_ROUTER/hello
|
|
||||||
Summary:
|
|
||||||
Total: 67.3535 secs
|
|
||||||
Slowest: 4.6192 secs
|
|
||||||
Fastest: 0.0177 secs
|
|
||||||
Average: 1.6464 secs
|
|
||||||
Requests/sec: 148.4704
|
|
||||||
Total data: 160000 bytes
|
|
||||||
Size/request: 16 bytes
|
|
||||||
|
|
||||||
Response time histogram:
|
|
||||||
0.018 [1] |
|
|
||||||
0.478 [486] |∎∎∎∎∎∎∎
|
|
||||||
0.938 [971] |∎∎∎∎∎∎∎∎∎∎∎∎∎∎
|
|
||||||
1.398 [2686] |∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎
|
|
||||||
1.858 [2326] |∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎
|
|
||||||
2.318 [1641] |∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎
|
|
||||||
2.779 [1157] |∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎
|
|
||||||
3.239 [574] |∎∎∎∎∎∎∎∎∎
|
|
||||||
3.699 [120] |∎∎
|
|
||||||
4.159 [0] |
|
|
||||||
4.619 [38] |∎
|
|
||||||
|
|
||||||
Latency distribution:
|
|
||||||
10% in 0.7037 secs
|
|
||||||
25% in 1.1979 secs
|
|
||||||
50% in 1.5038 secs
|
|
||||||
75% in 2.1959 secs
|
|
||||||
90% in 2.6670 secs
|
|
||||||
95% in 2.8855 secs
|
|
||||||
99% in 3.4102 secs
|
|
||||||
|
|
||||||
Details (average, fastest, slowest):
|
|
||||||
DNS+dialup: 0.0058 secs, 0.0000 secs, 1.0853 secs
|
|
||||||
DNS-lookup: 0.0000 secs, 0.0000 secs, 0.0000 secs
|
|
||||||
req write: 0.0000 secs, 0.0000 secs, 0.0026 secs
|
|
||||||
resp wait: 1.6405 secs, 0.0176 secs, 3.6144 secs
|
|
||||||
resp read: 0.0001 secs, 0.0000 secs, 0.0056 secs
|
|
||||||
|
|
||||||
Status code distribution:
|
|
||||||
[200] 10000 responses
|
|
||||||
|
|
||||||
```
|
|
||||||
While the load is being generated, we will watch the HorizontalPodAutoscaler and how it scales over period of time. As you can notice, the number of pods is scaled from 1 to 3 after the load rises from 8 - 103%. After the load generator stops, it takes a few iterations to scale down from 3 to 1 pod.
|
|
||||||
|
|
||||||
```
|
|
||||||
$ kubectl -n fission-function get hpa -w
|
|
||||||
NAME REFERENCE TARGETS MINPODS MAXPODS REPLICAS AGE
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 1 3m
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 8% / 50% 1 6 1 3m
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 103% / 50% 1 6 1 4m
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 103% / 50% 1 6 3 5m
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 25% / 50% 1 6 3 5m
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 25% / 50% 1 6 3 6m
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 3 6m
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 3 7m
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 3 7m
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 3 8m
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 3 8m
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 3 9m
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 3 9m
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 3 10m
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 5% / 50% 1 6 3 10m
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 7% / 50% 1 6 1 11m
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 6% / 50% 1 6 1 11m
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 6% / 50% 1 6 1 12m
|
|
||||||
hello-qoxmothj Deployment/hello-qoxmothj 6% / 50% 1 6 1 12m
|
|
||||||
```
|
|
||||||
@@ -1,271 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Function"
|
|
||||||
draft: false
|
|
||||||
weight: 41
|
|
||||||
---
|
|
||||||
|
|
||||||
### Create a function
|
|
||||||
|
|
||||||
Before creating a function the environment should be created, we will assume that you have already created environment named `node`.
|
|
||||||
|
|
||||||
Let's create a simple code snippet in nodejs which will output Hello world:
|
|
||||||
|
|
||||||
``` js
|
|
||||||
module.exports = async function(context) {
|
|
||||||
return {
|
|
||||||
status: 200,
|
|
||||||
body: "Hello, world!\n"
|
|
||||||
};
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Let's create a function based on pool based executor.
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ fission fn create --name hello --code hello.js --env node --executortype poolmgr
|
|
||||||
```
|
|
||||||
|
|
||||||
### Access function
|
|
||||||
|
|
||||||
Before accessing function, we need to set the `FISSION_ROUTER` environment variable first. It is needed for the examples below to work
|
|
||||||
|
|
||||||
#### Minikube
|
|
||||||
|
|
||||||
If you're using minikube, use these commands:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ export FISSION_ROUTER=$(minikube ip):$(kubectl -n fission get svc router -o jsonpath='{...nodePort}')
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Cloud setups
|
|
||||||
|
|
||||||
Save the external IP addresses of router services in FISSION_ROUTER.
|
|
||||||
|
|
||||||
Wait for services to get IP addresses (check this with `kubectl --namespace fission get svc`). Then:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
# AWS
|
|
||||||
$ export FISSION_ROUTER=$(kubectl --namespace fission get svc router -o=jsonpath='{..hostname}')
|
|
||||||
|
|
||||||
# GCP
|
|
||||||
$ export FISSION_ROUTER=$(kubectl --namespace fission get svc router -o=jsonpath='{..ip}')
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Create a HTTP trigger
|
|
||||||
|
|
||||||
Let's create a route for the function which can be used for making HTTP requests:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ fission route create --function hello --url /hello
|
|
||||||
trigger '5327e9a7-6d87-4533-a4fb-c67f55b1e492' created
|
|
||||||
```
|
|
||||||
|
|
||||||
When you hit this function's URL , you get a response:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ curl http://$FISSION_ROUTER/hello
|
|
||||||
Hello, world!
|
|
||||||
```
|
|
||||||
|
|
||||||
Similarly you can create a new deployment executor type function and provide minmum and maximum scale for the function.
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ fission fn create --name hello --code hello.js --env node --minscale 1 --maxscale 5 --executortype newdeploy
|
|
||||||
```
|
|
||||||
|
|
||||||
### View & update function source code
|
|
||||||
|
|
||||||
You can look at the source code associated with given function:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ fission fn get --name hello
|
|
||||||
module.exports = async function(context) {
|
|
||||||
return {
|
|
||||||
status: 200,
|
|
||||||
body: "Hello, world!\n"
|
|
||||||
};
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Let's say you want to update the function to output "Hello Fission" instead of "Hello world", you can update the source file and update the source code for function:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ fission fn update --name hello --code ../hello.js
|
|
||||||
package 'hello-js-ku9s' updated
|
|
||||||
function 'hello' updated
|
|
||||||
```
|
|
||||||
|
|
||||||
Let's verify that the function now respond with a different output than earlier:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ curl http://$FISSION_ROUTER/hello
|
|
||||||
Hello, Fission!
|
|
||||||
```
|
|
||||||
|
|
||||||
### Test and debug function
|
|
||||||
|
|
||||||
You can directly test a function using test command. If the function call succeeds, it will output the function's response.
|
|
||||||
``` bash
|
|
||||||
$ fission fn test --name hello
|
|
||||||
Hello, Fission!
|
|
||||||
```
|
|
||||||
|
|
||||||
But if there is an error in function execution then the logs of function execution are displayed:
|
|
||||||
``` bash
|
|
||||||
$ fission fn test --name hello
|
|
||||||
Error calling function hello: 500 Internal server error (fission)
|
|
||||||
|
|
||||||
> fission-nodejs-runtime@0.1.0 start /usr/src/app
|
|
||||||
> node server.js
|
|
||||||
|
|
||||||
Codepath defaulting to /userfunc/user
|
|
||||||
Port defaulting to 8888
|
|
||||||
user code load error: SyntaxError: Unexpected token function
|
|
||||||
::ffff:10.8.1.181 - - [16/Feb/2018:08:44:33 +0000] "POST /specialize HTTP/1.1" 500 2 "-" "Go-http-client/1.1"
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also look at function execution logs explicitly:
|
|
||||||
``` bash
|
|
||||||
$ fission fn logs --name hello
|
|
||||||
[2018-02-16 08:41:43 +0000 UTC] 2018/02/16 08:41:43 fetcher received fetch request and started downloading: {1 {hello-js-rqew default 0 0001-01-01 00:00:00 +0000 UTC <nil> <nil> map[] map[] [] nil [] } user [] []}
|
|
||||||
[2018-02-16 08:41:43 +0000 UTC] 2018/02/16 08:41:43 Successfully placed at /userfunc/user
|
|
||||||
[2018-02-16 08:41:43 +0000 UTC] 2018/02/16 08:41:43 Checking secrets/cfgmaps
|
|
||||||
[2018-02-16 08:41:43 +0000 UTC] 2018/02/16 08:41:43 Completed fetch request
|
|
||||||
[2018-02-16 08:41:43 +0000 UTC] 2018/02/16 08:41:43 elapsed time in fetch request = 89.844653ms
|
|
||||||
[2018-02-16 08:41:43 +0000 UTC] user code loaded in 0sec 4.235593ms
|
|
||||||
[2018-02-16 08:41:43 +0000 UTC] ::ffff:10.8.1.181 - - [16/Feb/2018:08:41:43 +0000] "POST /specialize HTTP/1.1" 202 - "-" "Go-http-client/1.1"
|
|
||||||
[2018-02-16 08:41:43 +0000 UTC] ::ffff:10.8.1.182 - - [16/Feb/2018:08:41:43 +0000] "GET / HTTP/1.1" 200 16 "-" "curl/7.54.0"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Fission builds & compiled artifacts
|
|
||||||
|
|
||||||
Most real world functions will require more than one source files. It is also easier to simply provide source files and let Fission take care of building from source files. Fission provides first class support for building from source as well as using compiled artifacts to create functions.
|
|
||||||
|
|
||||||
You can attach the source/deployment packages to a function or explicitly create packages and use them across functions. Check documentation for [package](../package) for more information.
|
|
||||||
|
|
||||||
#### Building function from source
|
|
||||||
|
|
||||||
Let's take a simple python function which has dependency on a python pyyaml module. We can specify the dependencies in requirements.txt and a simple command to build from source. The tree structure of directory looks like:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
sourcepkg/
|
|
||||||
├── __init__.py
|
|
||||||
├── build.sh
|
|
||||||
├── requirements.txt
|
|
||||||
└── user.py
|
|
||||||
```
|
|
||||||
|
|
||||||
And the file contents:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ cat user.py
|
|
||||||
import sys
|
|
||||||
import yaml
|
|
||||||
|
|
||||||
document = """
|
|
||||||
a: 1
|
|
||||||
b:
|
|
||||||
c: 3
|
|
||||||
d: 4
|
|
||||||
"""
|
|
||||||
|
|
||||||
def main():
|
|
||||||
return yaml.dump(yaml.load(document))
|
|
||||||
|
|
||||||
$ cat requirements.txt
|
|
||||||
pyyaml
|
|
||||||
|
|
||||||
$ cat build.sh
|
|
||||||
#!/bin/sh
|
|
||||||
pip3 install -r ${SRC_PKG}/requirements.txt -t ${SRC_PKG} && cp -r ${SRC_PKG} ${DEPLOY_PKG}
|
|
||||||
```
|
|
||||||
|
|
||||||
You first need to create an environment with environment image and python-builder image specified:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ fission env create --name python --image fission/python-env:latest --builder fission/python-builder:latest --mincpu 40 --maxcpu 80 --minmemory 64 --maxmemory 128 --poolsize 2
|
|
||||||
```
|
|
||||||
|
|
||||||
Now let's zip the directory containing the source files and create a function with source package:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ zip -jr demo-src-pkg.zip sourcepkg/
|
|
||||||
adding: __init__.py (stored 0%)
|
|
||||||
adding: build.sh (deflated 24%)
|
|
||||||
adding: requirements.txt (stored 0%)
|
|
||||||
adding: user.py (deflated 25%)
|
|
||||||
|
|
||||||
$ fission fn create --name hellopy --env python --src demo-src-pkg.zip --entrypoint "user.main" --buildcmd "./build.sh"
|
|
||||||
function 'hellopy' created
|
|
||||||
|
|
||||||
$ fission route create --function hellopy --url /hellopy
|
|
||||||
```
|
|
||||||
|
|
||||||
Once we create the function, the build process is started. You can check logs of the builder in fission-builder namespace:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ kubectl -n fission-builder logs -f py3-4214348-59555d9bd8-ks7m4 builder
|
|
||||||
2018/02/16 11:44:21 Builder received request: {demo-src-pkg-zip-ninf-djtswo ./build.sh}
|
|
||||||
2018/02/16 11:44:21 Starting build...
|
|
||||||
|
|
||||||
=== Build Logs ===command=./build.sh
|
|
||||||
env=[PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin HOSTNAME=py3-4214348-59555d9bd8-ks7m4 PYTHON_4212095_PORT_8000_TCP_PROTO=tcp PY3_4214348_SERVICE_HOST=10.11.250.161 KUBERNETES_PORT=tcp://10.11.240.1:443 PYTHON_4212095_PORT=tcp://10.11.244.134:8000 PYTHON_4212095_PORT_8000_TCP=tcp://10.11.244.134:8000 PYTHON_4212095_PORT_8001_TCP_PROTO=tcp PYTHON_4212095_PORT_8001_TCP_ADDR=10.11.244.134 PY3_4214348_SERVICE_PORT=8000 PY3_4214348_SERVICE_PORT_BUILDER_PORT=8001 PY3_4214348_PORT_8001_TCP=tcp://10.11.250.161:8001 KUBERNETES_PORT_443_TCP_PORT=443 KUBERNETES_PORT_443_TCP_ADDR=10.11.240.1 PY3_4214348_SERVICE_PORT_FETCHER_PORT=8000 PY3_4214348_PORT_8000_TCP=tcp://10.11.250.161:8000 PY3_4214348_PORT_8001_TCP_PORT=8001 PYTHON_4212095_SERVICE_PORT_FETCHER_PORT=8000 PYTHON_4212095_PORT_8000_TCP_ADDR=10.11.244.134 KUBERNETES_SERVICE_HOST=10.11.240.1 PY3_4214348_PORT=tcp://10.11.250.161:8000 PYTHON_4212095_SERVICE_PORT_BUILDER_PORT=8001 PYTHON_4212095_PORT_8001_TCP=tcp://10.11.244.134:8001 PY3_4214348_PORT_8000_TCP_PROTO=tcp PY3_4214348_PORT_8000_TCP_PORT=8000 KUBERNETES_SERVICE_PORT_HTTPS=443 KUBERNETES_PORT_443_TCP=tcp://10.11.240.1:443 PYTHON_4212095_PORT_8001_TCP_PORT=8001 PY3_4214348_PORT_8000_TCP_ADDR=10.11.250.161 PY3_4214348_PORT_8001_TCP_PROTO=tcp KUBERNETES_SERVICE_PORT=443 PYTHON_4212095_SERVICE_PORT=8000 PYTHON_4212095_PORT_8000_TCP_PORT=8000 PY3_4214348_PORT_8001_TCP_ADDR=10.11.250.161 KUBERNETES_PORT_443_TCP_PROTO=tcp PYTHON_4212095_SERVICE_HOST=10.11.244.134 HOME=/root SRC_PKG=/packages/demo-src-pkg-zip-ninf-djtswo DEPLOY_PKG=/packages/demo-src-pkg-zip-ninf-djtswo-c40gfu]
|
|
||||||
Collecting pyyaml (from -r /packages/demo-src-pkg-zip-ninf-djtswo/requirements.txt (line 1))
|
|
||||||
Downloading PyYAML-3.12.tar.gz (253kB)
|
|
||||||
Installing collected packages: pyyaml
|
|
||||||
Running setup.py install for pyyaml: started
|
|
||||||
Running setup.py install for pyyaml: finished with status 'done'
|
|
||||||
Successfully installed pyyaml-3.12
|
|
||||||
==================
|
|
||||||
2018/02/16 11:44:24 elapsed time in build request = 3.460498847s
|
|
||||||
```
|
|
||||||
|
|
||||||
Once the build has succeeded, you can hit the function URL to test the function:
|
|
||||||
``` bash
|
|
||||||
$ curl http://$FISSION_ROUTER/hellopy
|
|
||||||
a: 1
|
|
||||||
b: {c: 3, d: 4}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Using compiled artifacts with Fission
|
|
||||||
|
|
||||||
In some cases you have a pre-built deployment package which you need to deploy to Fission. For this example let's use a simple python file as a deployment package but in practice it can be any other compiled package.
|
|
||||||
|
|
||||||
We will use a simple python file in a directory and turn it into a deployment package:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ cat testDir/hello.py
|
|
||||||
def main():
|
|
||||||
return "Hello, world!"
|
|
||||||
|
|
||||||
$zip -jr demo-deploy-pkg.zip testDir/
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Let's use the deployment package to create a function and route and then test it.
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ fission fn create --name hellopy --env python --deploy demo-deploy-pkg.zip --entrypoint "hello.main"
|
|
||||||
function 'hellopy' created
|
|
||||||
|
|
||||||
$ fission route create --function hellopy --url /hellopy
|
|
||||||
|
|
||||||
$ curl http://$FISSION_ROUTER/hellopy
|
|
||||||
Hello, world!
|
|
||||||
```
|
|
||||||
|
|
||||||
### View function information
|
|
||||||
|
|
||||||
You can retrieve metadata information of a single function or list all functions to look at basic information of functions:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ fission fn getmeta --name hello
|
|
||||||
NAME UID ENV
|
|
||||||
hello 34234b50-12f5-11e8-85c9-42010aa00010 node
|
|
||||||
|
|
||||||
$ fission fn list
|
|
||||||
NAME UID ENV EXECUTORTYPE MINSCALE MAXSCALE TARGETCPU
|
|
||||||
hello 34234b50-12f5-11e8-85c9-42010aa00010 node poolmgr 0 1 80
|
|
||||||
hello2 e37a46e3-12f4-11e8-85c9-42010aa00010 node newdeploy 1 5 80
|
|
||||||
```
|
|
||||||
@@ -1,130 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Packaging source code"
|
|
||||||
draft: false
|
|
||||||
weight: 46
|
|
||||||
---
|
|
||||||
|
|
||||||
### Creating source package
|
|
||||||
|
|
||||||
Before you create a package, you need to create an environment with associated builder image:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ fission env create --name pythonsrc --image fission/python-env:latest --builder fission/python-builder:latest --mincpu 40 --maxcpu 80 --minmemory 64 --maxmemory 128 --poolsize 2
|
|
||||||
environment 'pythonsrc' created
|
|
||||||
```
|
|
||||||
|
|
||||||
Let's take a simple python function which has dependency on a python pyyaml module. We can specify the dependencies in requirements.txt and a simple command to build from source. The tree structure of directory and contents of the file looks like:
|
|
||||||
|
|
||||||
```
|
|
||||||
sourcepkg/
|
|
||||||
├── __init__.py
|
|
||||||
├── build.sh
|
|
||||||
├── requirements.txt
|
|
||||||
└── user.py
|
|
||||||
```
|
|
||||||
And the file contents:
|
|
||||||
```
|
|
||||||
$ cat user.py
|
|
||||||
import sys
|
|
||||||
import yaml
|
|
||||||
|
|
||||||
document = """
|
|
||||||
a: 1
|
|
||||||
b:
|
|
||||||
c: 3
|
|
||||||
d: 4
|
|
||||||
"""
|
|
||||||
|
|
||||||
def main():
|
|
||||||
return yaml.dump(yaml.load(document))
|
|
||||||
|
|
||||||
$ cat requirements.txt
|
|
||||||
pyyaml
|
|
||||||
|
|
||||||
$ cat build.sh
|
|
||||||
#!/bin/sh
|
|
||||||
pip3 install -r ${SRC_PKG}/requirements.txt -t ${SRC_PKG} && cp -r ${SRC_PKG} ${DEPLOY_PKG}
|
|
||||||
|
|
||||||
$zip -jr demo-src-pkg.zip sourcepkg/
|
|
||||||
adding: __init__.py (stored 0%)
|
|
||||||
adding: build.sh (deflated 24%)
|
|
||||||
adding: requirements.txt (stored 0%)
|
|
||||||
adding: user.py (deflated 25%)
|
|
||||||
```
|
|
||||||
Using the source archive creared in previous step, you can create a package in Fission:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ fission package create --sourcearchive demo-src-pkg.zip --env pythonsrc --buildcmd "./build.sh"
|
|
||||||
Package 'demo-src-pkg-zip-8lwt' created
|
|
||||||
```
|
|
||||||
|
|
||||||
Since we are working with source package, we provided the build command. Once you create the package, the build process will start and you can check the build logs by getting information of the package:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ fission pkg info --name demo-src-pkg-zip-8lwt
|
|
||||||
Name: demo-src-pkg-zip-8lwt
|
|
||||||
Environment: pythonsrc
|
|
||||||
Status: succeeded
|
|
||||||
Build Logs:
|
|
||||||
Collecting pyyaml (from -r /packages/demo-src-pkg-zip-8lwt-v57qil/requirements.txt (line 1))
|
|
||||||
Using cached PyYAML-3.12.tar.gz
|
|
||||||
Installing collected packages: pyyaml
|
|
||||||
Running setup.py install for pyyaml: started
|
|
||||||
Running setup.py install for pyyaml: finished with status 'done'
|
|
||||||
Successfully installed pyyaml-3.12
|
|
||||||
```
|
|
||||||
|
|
||||||
Using the package above you can create the function. Since package already is associated with a source package, environment and build command, these will be ignored when creating a function. Only addition thing you will need to provide is the entrypoint. Assuming you hace created the route, the function should be reachable with successful output:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ fission fn create --name srcpy --pkg demo-src-pkg-zip-8lwt --entrypoint "user.main"
|
|
||||||
function 'srcpy' created
|
|
||||||
|
|
||||||
$ curl http://$FISSION_ROUTER/srcpy
|
|
||||||
a: 1
|
|
||||||
b: {c: 3, d: 4}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Creating deployment package
|
|
||||||
|
|
||||||
Before you create a package you need to create an environment with the builder image:
|
|
||||||
```
|
|
||||||
$ fission env create --name pythondeploy --image fission/python-env:latest --builder fission/python-builder:latest --mincpu 40 --maxcpu 80 --minmemory 64 --maxmemory 128 --poolsize 2
|
|
||||||
environment 'pythonsrc' created
|
|
||||||
```
|
|
||||||
|
|
||||||
We will use a simple Python example which outputs "Hello World!" in a directory to create a deployment archive:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ cat testDir/hello.py
|
|
||||||
def main():
|
|
||||||
return "Hello, world!"
|
|
||||||
|
|
||||||
$zip -jr demo-deploy-pkg.zip testDir/
|
|
||||||
|
|
||||||
```
|
|
||||||
Using the archive and environments created previously, you can create a package:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ fission package create --deployarchive demo-deploy-pkg.zip --env pythondeploy
|
|
||||||
Package 'demo-deploy-pkg-zip-whzl' created
|
|
||||||
```
|
|
||||||
|
|
||||||
Since it is a deployment archive, there is no need to build it, hence the build logs for the package will be empty:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ fission package info --name demo-deploy-pkg-zip-whzl
|
|
||||||
Name: demo-deploy-pkg-zip-xlaw
|
|
||||||
Environment: pythondeploy2
|
|
||||||
Status: succeeded
|
|
||||||
Build Logs:
|
|
||||||
```
|
|
||||||
|
|
||||||
Finally you can create a function with the package and test the function:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ fission fn create --name deploypy --pkg demo-deploy-pkg-zip-whzl --entrypoint "hello.main"
|
|
||||||
|
|
||||||
$curl http://$FISSION_ROUTER/deploypy
|
|
||||||
Hello, world!
|
|
||||||
```
|
|
||||||
@@ -1,53 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Triggers"
|
|
||||||
draft: false
|
|
||||||
weight: 44
|
|
||||||
---
|
|
||||||
|
|
||||||
### Create a HTTP Trigger
|
|
||||||
|
|
||||||
You can create a HTTP trigger with default method (GET) for a function:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ fission ht create --url /hello --function hello
|
|
||||||
trigger '94cd5163-30dd-4fb2-ab3c-794052f70841' created
|
|
||||||
```
|
|
||||||
|
|
||||||
### Create a Time Trigger
|
|
||||||
|
|
||||||
Time based triggers can be created with cron specifications:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ fission tt create --name halfhourly --function hello --cron "0 30 * * *"
|
|
||||||
trigger 'halfhourly' created
|
|
||||||
```
|
|
||||||
|
|
||||||
Also a more friendly syntax such "every 1m" or "@hourly" can be used to create a time based trigger.
|
|
||||||
|
|
||||||
```
|
|
||||||
$ fission tt create --name minute --function hello --cron "@every 1m"
|
|
||||||
trigger 'minute' created
|
|
||||||
```
|
|
||||||
|
|
||||||
You can list time based triggers to inspect their associated function and cron specifications:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ fission tt list
|
|
||||||
NAME CRON FUNCTION_NAME
|
|
||||||
halfhourly 0 30 * * * hello
|
|
||||||
minute @every 1m hello
|
|
||||||
```
|
|
||||||
|
|
||||||
### Create a Message Queue Trigger
|
|
||||||
|
|
||||||
A message queue trigger invokes a function based on messages from an
|
|
||||||
message queue. Currently, NATS and Azure Storage Queue are supported
|
|
||||||
queues. (Kafka support is under development.)
|
|
||||||
|
|
||||||
```
|
|
||||||
$ fission mqt create --name hellomsg --function hello --mqtype nats-streaming --topic newfile --resptopic newfileresponse
|
|
||||||
trigger 'hellomsg' created
|
|
||||||
```
|
|
||||||
|
|
||||||
You can list or update message queue triggers with `fission mqt list`,
|
|
||||||
or `fission mqt update`.
|
|
||||||
@@ -1,158 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Fission Workflows"
|
|
||||||
draft: false
|
|
||||||
weight: 70
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
### Prerequisites
|
|
||||||
|
|
||||||
Fission Workflows requires the following components to be installed on your local machine:
|
|
||||||
|
|
||||||
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
|
|
||||||
- [helm](https://github.com/kubernetes/helm)
|
|
||||||
|
|
||||||
|
|
||||||
Fission Workflows is deployed on top of a Kubernetes cluster.
|
|
||||||
If you don't have a Kubernetes cluster, [here's a quick guide to set one up](../kubernetessetup).
|
|
||||||
It also requires a [Fission](https://github.com/fission/fission) deployment to be present on your Kubernetes cluster.
|
|
||||||
If you do not have a Fission deployment, follow [Fission's installation guide](../install).
|
|
||||||
|
|
||||||
**(Note that Fission Workflows 0.2.0 requires Fission 0.4.1 or higher, with the NATS component installed!)**
|
|
||||||
|
|
||||||
### Installing Fission Workflows
|
|
||||||
|
|
||||||
Fission Workflows is an add-on to Fission. You can install both
|
|
||||||
Fission and Fission Workflows using helm charts.
|
|
||||||
|
|
||||||
Assuming you have your Kubernetes cluster set up with a functioning deployment of Fission 0.4.1 or higher, run the following commands:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# If you haven't already, add the Fission charts repo
|
|
||||||
$ helm repo add fission-charts https://fission.github.io/fission-charts/
|
|
||||||
|
|
||||||
$ helm repo update
|
|
||||||
|
|
||||||
# Install Fission Workflows
|
|
||||||
$ helm install --wait -n fission-workflows fission-charts/fission-workflows --version 0.2.0
|
|
||||||
```
|
|
||||||
|
|
||||||
### Creating your first workflow
|
|
||||||
|
|
||||||
After installing Fission and Workflows, you're all set to run a simple
|
|
||||||
test workflow.
|
|
||||||
With the following code snippet you will be able to deploy and run a small workflow example:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Fetch the required files, alternatively you could clone the fission-workflow repo
|
|
||||||
$ curl https://raw.githubusercontent.com/fission/fission-workflows/0.2.0/examples/whales/fortune.sh > fortune.sh
|
|
||||||
|
|
||||||
$ curl https://raw.githubusercontent.com/fission/fission-workflows/0.2.0/examples/whales/whalesay.sh > whalesay.sh
|
|
||||||
|
|
||||||
$ curl https://raw.githubusercontent.com/fission/fission-workflows/0.2.0/examples/whales/fortunewhale.wf.yaml > fortunewhale.wf.yaml
|
|
||||||
|
|
||||||
#
|
|
||||||
# Add binary environment and create two test functions on your Fission setup:
|
|
||||||
#
|
|
||||||
$ fission env create --name binary --image fission/binary-env
|
|
||||||
|
|
||||||
$ fission function create --name whalesay --env binary --deploy ./whalesay.sh
|
|
||||||
|
|
||||||
$ fission function create --name fortune --env binary --deploy ./fortune.sh
|
|
||||||
|
|
||||||
#
|
|
||||||
# Create a workflow that uses those two functions. A workflow is just
|
|
||||||
# a function that uses the "workflow" environment.
|
|
||||||
#
|
|
||||||
$ fission function create --name fortunewhale --env workflow --src ./fortunewhale.wf.yaml
|
|
||||||
|
|
||||||
#
|
|
||||||
# Map an HTTP GET to your new workflow function:
|
|
||||||
#
|
|
||||||
$ fission route create --method GET --url /fortunewhale --function fortunewhale
|
|
||||||
|
|
||||||
#
|
|
||||||
# Invoke the workflow with an HTTP request:
|
|
||||||
#
|
|
||||||
$ curl ${FISSION_ROUTER}/fortunewhale
|
|
||||||
```
|
|
||||||
|
|
||||||
This last command, the invocation of the workflow, should return a whale saying something wise
|
|
||||||
|
|
||||||
```
|
|
||||||
______________________________________
|
|
||||||
/ Anthony's Law of Force: \
|
|
||||||
| |
|
|
||||||
\ Don't force it; get a larger hammer. /
|
|
||||||
--------------------------------------
|
|
||||||
\
|
|
||||||
\
|
|
||||||
\
|
|
||||||
## .
|
|
||||||
## ## ## ==
|
|
||||||
## ## ## ## ## ===
|
|
||||||
/"""""""""""""""""\___/ ===
|
|
||||||
{ / ===-
|
|
||||||
\______ O __/
|
|
||||||
\ \ __/
|
|
||||||
\____\_______/
|
|
||||||
```
|
|
||||||
|
|
||||||
So what happened here?
|
|
||||||
Let's see what the workflow consists of (for example by running `cat fortunewhale.wf.yaml`):
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# This whale shows off a basic workflow that combines both Fission Functions (fortune, whalesay) and internal functions (noop)
|
|
||||||
apiVersion: 1
|
|
||||||
output: WhaleWithFortune
|
|
||||||
tasks:
|
|
||||||
InternalFuncShowoff:
|
|
||||||
run: noop
|
|
||||||
|
|
||||||
GenerateFortune:
|
|
||||||
run: fortune
|
|
||||||
requires:
|
|
||||||
- InternalFuncShowoff
|
|
||||||
|
|
||||||
WhaleWithFortune:
|
|
||||||
run: whalesay
|
|
||||||
inputs: "{$.Tasks.GenerateFortune.Output}"
|
|
||||||
requires:
|
|
||||||
- GenerateFortune
|
|
||||||
```
|
|
||||||
|
|
||||||
What you see is the [YAML](http://yaml.org/)-based workflow definition of the `fortunewhale` workflow.
|
|
||||||
A workflow consists of multiple tasks, which are steps that it needs to complete.
|
|
||||||
Each task has a unique identifier, such as `GenerateFortune`, a reference to a Fission function in the `run` field.
|
|
||||||
Optionally, it can contain `inputs` which allows you to specify inputs to the task,
|
|
||||||
as well as contain `requires` which allows you to specify which tasks need to complete before this task can start.
|
|
||||||
Finally, at the top you will find the `output` field, which specifies the task whose output is used as the workflow's output.
|
|
||||||
|
|
||||||
In this case, the `fortunewhale` workflow consists of a sequence of 3 tasks:
|
|
||||||
```
|
|
||||||
InternalFuncShowoff -> GenerateFortune -> WhaleWithFortune
|
|
||||||
```
|
|
||||||
First, it starts with `InternalFuncShowoff` by running `noop`, which is an *internal function* in the workflow engine.
|
|
||||||
Internal functions are run inside of the workflow engine, which makes them run much faster at the cost of expressiveness and scalability.
|
|
||||||
So typically, light-weight functions, such as logic or control flow operations, are good candidates to be used as internal functions.
|
|
||||||
Besides, a minimal set of predefined internal functions, you can define internal function - there is nothing special about them.
|
|
||||||
|
|
||||||
After `InternalFuncShowff` completes, the `GenerateFortune` task can start as its `requires` has been fulfilled.
|
|
||||||
It runs the `fortune` Fission function, which outputs a random piece of wisdom.
|
|
||||||
|
|
||||||
After `GenerateFortune` completes, the `WhaleWithFortune` task can start.
|
|
||||||
This task uses a javascript expression in its `inputs` to reference the output of the `GenerateFortune` task.
|
|
||||||
In the inputs of a task you can reference anything in the workflow, such as outputs, inputs, and task definitions, or just provide a constant value.
|
|
||||||
The workflow engine invokes the `whalesay` fission function with as input the piece of wisdom, which outputs the ASCI whale that wraps the phrase.
|
|
||||||
|
|
||||||
Finally, with all tasks completed, the workflow engine uses the top-level `output` field to fetch the output of the `WhaleWithFortune` and return it to the user.
|
|
||||||
As the workflow engine adheres to the Fission function specification, a Fission workflow is just another Fission Function.
|
|
||||||
This means that you could use this workflow as a function in the `run` in other workflows.
|
|
||||||
|
|
||||||
### What's next?
|
|
||||||
To learn more about the Fission Workflows system and its advanced concepts, see the [documentation on Github](https://github.com/fission/fission-workflows/tree/master/Docs).
|
|
||||||
|
|
||||||
Or, check out the [examples](https://github.com/fission/fission-workflows/tree/0.2.0/examples) for more example workflows.
|
|
||||||
|
|
||||||
If something went wrong, we'd love to help -- please [drop by the slack channel](http://slack.fission.io) and ask for help.
|
|
||||||
|
|
||||||
|
Before Width: | Height: | Size: 5.7 KiB |
|
Before Width: | Height: | Size: 32 KiB |
@@ -1,22 +0,0 @@
|
|||||||
The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2014 Grav
|
|
||||||
Copyright (c) 2016 MATHIEU CORNIC
|
|
||||||
Copyright (c) 2017 Valere JEANTET
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
||||||
this software and associated documentation files (the "Software"), to deal in
|
|
||||||
the Software without restriction, including without limitation the rights to
|
|
||||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
||||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
|
||||||
subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
||||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
||||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
||||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
||||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
@@ -1,53 +0,0 @@
|
|||||||
# Hugo Learn Theme
|
|
||||||
|
|
||||||
This repository contains a theme for [Hugo](https://gohugo.io/), based on great [Grav Learn Theme](http://learn.getgrav.org/).
|
|
||||||
|
|
||||||
Visit the [theme documentation](https://learn.netlify.com/en/) to see what is going on. It is actually built with this theme.
|
|
||||||
|
|
||||||
## Main features
|
|
||||||
|
|
||||||
- Automatic Search
|
|
||||||
- Multilingual mode
|
|
||||||
- Unlimited menu levels
|
|
||||||
- Automatic next/prev buttons to navigate through menu entries
|
|
||||||
- Image resizing, shadow…
|
|
||||||
- Attachments files
|
|
||||||
- List child pages
|
|
||||||
- Mermaid diagram (flowchart, sequence, gantt)
|
|
||||||
- Customizable look and feel and themes variants
|
|
||||||
- Buttons, Tip/Note/Info/Warning boxes, Expand
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
Navigate to your themes folder in your Hugo site and use the following commands:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ cd themes
|
|
||||||
$ git clone https://github.com/matcornic/hugo-theme-learn.git
|
|
||||||
```
|
|
||||||
|
|
||||||
Check that your Hugo version is minimum `0.25` with `hugo version`.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
- [Visit the documentation](https://learn.netlify.com/en/)
|
|
||||||
|
|
||||||
## Download old versions (prior to 2.0.0)
|
|
||||||
|
|
||||||
If you need old version for compatibility purpose, either download [theme source code from releases](https://github.com/matcornic/hugo-theme-learn/releases) or use the right git tag. For example, with `1.1.0`
|
|
||||||
|
|
||||||
- Direct download way: https://github.com/matcornic/hugo-theme-learn/archive/1.1.0.zip
|
|
||||||
- Git way:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
cd themes/hugo-theme-learn
|
|
||||||
git checkout tags/1.1.0
|
|
||||||
```
|
|
||||||
|
|
||||||
For both solutions, the documentation is available at https://github.com/matcornic/hugo-theme-learn/releases/download/1.1.0/hugo-learn-doc-1.1.0.zip
|
|
||||||
|
|
||||||
## Credits
|
|
||||||
|
|
||||||
Many thanks to [@vjeantet](https://github.com/vjeantet/) for the fork [docdock](https://github.com/vjeantet/hugo-theme-docdock). The v2 of this theme is mainly based on his work !
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
+++
|
|
||||||
title = "{{ replace .TranslationBaseName "-" " " | title }}"
|
|
||||||
date = {{ .Date }}
|
|
||||||
weight = 5
|
|
||||||
chapter = true
|
|
||||||
pre = "<b>X. </b>"
|
|
||||||
+++
|
|
||||||
|
|
||||||
### Chapter X
|
|
||||||
|
|
||||||
# Some Chapter title
|
|
||||||
|
|
||||||
Lorem Ipsum.
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
+++
|
|
||||||
title = "{{ replace .TranslationBaseName "-" " " | title }}"
|
|
||||||
date = {{ .Date }}
|
|
||||||
weight = 5
|
|
||||||
+++
|
|
||||||
|
|
||||||
Lorem Ipsum.
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2016 MATHIEU CORNIC
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
||||||
this software and associated documentation files (the "Software"), to deal in
|
|
||||||
the Software without restriction, including without limitation the rights to
|
|
||||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
||||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
|
||||||
subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
||||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
||||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
||||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
||||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
@@ -1,73 +0,0 @@
|
|||||||
baseURL = "/"
|
|
||||||
languageCode = "en-US"
|
|
||||||
defaultContentLanguage = "en"
|
|
||||||
|
|
||||||
title = "Hugo Learn Documentation"
|
|
||||||
theme = "learn"
|
|
||||||
themesdir = "../.."
|
|
||||||
metaDataFormat = "yaml"
|
|
||||||
defaultContentLanguageInSubdir= true
|
|
||||||
|
|
||||||
[params]
|
|
||||||
editURL = "https://github.com/matcornic/hugo-theme-learn/edit/master/exampleSite/content/"
|
|
||||||
description = "Documentation for Hugo Learn Theme"
|
|
||||||
author = "Mathieu Cornic"
|
|
||||||
showVisitedLinks = true
|
|
||||||
|
|
||||||
[outputs]
|
|
||||||
home = [ "HTML", "RSS", "JSON"]
|
|
||||||
|
|
||||||
[Languages]
|
|
||||||
[Languages.en]
|
|
||||||
title = "Documentation for Hugo Learn Theme"
|
|
||||||
weight = 1
|
|
||||||
languageName = "English"
|
|
||||||
|
|
||||||
[[Languages.en.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-fw fa-github'></i> Github repo"
|
|
||||||
identifier = "ds"
|
|
||||||
url = "https://github.com/matcornic/hugo-theme-learn"
|
|
||||||
weight = 10
|
|
||||||
|
|
||||||
[[Languages.en.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-fw fa-camera'></i> Showcases"
|
|
||||||
url = "showcase"
|
|
||||||
weight = 11
|
|
||||||
|
|
||||||
[[Languages.en.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-fw fa-bookmark'></i> Hugo Documentation"
|
|
||||||
identifier = "hugodoc"
|
|
||||||
url = "https://gohugo.io/"
|
|
||||||
weight = 20
|
|
||||||
|
|
||||||
[[Languages.en.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-fw fa-bullhorn'></i> Credits"
|
|
||||||
url = "/credits"
|
|
||||||
weight = 30
|
|
||||||
|
|
||||||
[Languages.fr]
|
|
||||||
title = "Documentation du thème Hugo Learn"
|
|
||||||
weight = 2
|
|
||||||
languageName = "Français"
|
|
||||||
|
|
||||||
[[Languages.fr.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-fw fa-github'></i> Repo Github"
|
|
||||||
identifier = "ds"
|
|
||||||
url = "https://github.com/matcornic/hugo-theme-learn"
|
|
||||||
weight = 10
|
|
||||||
|
|
||||||
[[Languages.fr.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-fw fa-camera'></i> Vitrine"
|
|
||||||
url = "/showcase"
|
|
||||||
weight = 11
|
|
||||||
|
|
||||||
[[Languages.fr.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-fw fa-bookmark'></i> Documentation Hugo"
|
|
||||||
identifier = "hugodoc"
|
|
||||||
url = "https://gohugo.io/"
|
|
||||||
weight = 20
|
|
||||||
|
|
||||||
[[Languages.fr.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-fw fa-bullhorn'></i> Crédits"
|
|
||||||
url = "/credits"
|
|
||||||
weight = 30
|
|
||||||
@@ -1,41 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Learn Theme for Hugo"
|
|
||||||
---
|
|
||||||
|
|
||||||
# Hugo learn theme
|
|
||||||
|
|
||||||
[Hugo-theme-learn](http://github.com/matcornic/hugo-theme-learn) is a theme for [Hugo](https://gohugo.io/), a fast and modern static website engine written in Go. Where Hugo is often used for blogs, this multilingual-ready theme is **fully designed for documentation**.
|
|
||||||
|
|
||||||
This theme is a partial porting of the [Learn theme](http://learn.getgrav.org/) of [Grav](https://getgrav.org/), a modern flat-file CMS written in PHP.
|
|
||||||
|
|
||||||
{{% notice tip %}}Learn theme works with a _page tree structure_ to organize content : All contents are pages, which belong to other pages. [read more about this]({{%relref "cont/pages/_index.md"%}})
|
|
||||||
{{% /notice %}}
|
|
||||||
|
|
||||||
## Main features
|
|
||||||
|
|
||||||
* [Automatic Search]({{%relref "basics/configuration/_index.md#activate-search" %}})
|
|
||||||
* [Multilingual mode]({{%relref "cont/i18n/_index.md" %}})
|
|
||||||
* **Unlimited menu levels**
|
|
||||||
* **Automatic next/prev buttons to navigate through menu entries**
|
|
||||||
* [Image resizing, shadow...]({{%relref "cont/markdown.en.md#images" %}})
|
|
||||||
* [Attachments files]({{%relref "shortcodes/attachments.en.md" %}})
|
|
||||||
* [List child pages]({{%relref "shortcodes/children/_index.md" %}})
|
|
||||||
* [Mermaid diagram]({{%relref "shortcodes/mermaid.en.md" %}}) (flowchart, sequence, gantt)
|
|
||||||
* [Customizable look and feel and themes variants]({{%relref "basics/style-customization/_index.md"%}})
|
|
||||||
* [Buttons]({{%relref "shortcodes/button.en.md" %}}), [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice.en.md" %}}), [Expand]({{%relref "shortcodes/expand.en.md" %}})
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## Contribute to this documentation
|
|
||||||
Feel free to update this content, just click the **Edit this page** link displayed on top right of each page, and pullrequest it
|
|
||||||
|
|
||||||
{{% notice info %}}
|
|
||||||
Your modification will be deployed automatically when merged.
|
|
||||||
{{% /notice %}}
|
|
||||||
|
|
||||||
## Documentation website
|
|
||||||
This current documentation has been statically generated with Hugo with a simple command : `hugo -t hugo-theme-learn` -- source code is [available here at GitHub](https://github.com/matcornic/hugo-theme-learn)
|
|
||||||
|
|
||||||
{{% notice note %}}
|
|
||||||
Automatically published and hosted thanks to [Netlify](https://www.netlify.com/). Read more about [Automated HUGO deployments with Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)
|
|
||||||
{{% /notice %}}
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Learn Theme for Hugo"
|
|
||||||
---
|
|
||||||
|
|
||||||
# Thème Hugo learn
|
|
||||||
|
|
||||||
[Hugo-theme-learn](http://github.com/matcornic/hugo-theme-learn) est un thème pour [Hugo](https://gohugo.io/), un générateur de site statique, rapide et modern, écrit en Go. Tandis que Hugo est souvent utilisé pour des blogs, ce thème multi-langue est **entièrement conçu pour la documentation**.
|
|
||||||
|
|
||||||
Ce thème est un portage partiel du [thème Learn](http://learn.getgrav.org/) de [Grav](https://getgrav.org/), un CMS modern écrit en PHP.
|
|
||||||
|
|
||||||
{{% notice tip %}}Le thème Learn fonctionne grâce à la structure de page aborescentes pour organiser le contenu: tous les contenus sont des pages qui appartiennent à d'autres pages. [Plus d'infos]({{%relref "cont/pages/_index.md"%}})
|
|
||||||
{{% /notice %}}
|
|
||||||
|
|
||||||
## Fonctionnalités principales
|
|
||||||
|
|
||||||
* [Recherche automatique]({{%relref "basics/configuration/_index.md#activer-recherche" %}})
|
|
||||||
* [Mode multi-langue]({{%relref "cont/i18n/_index.md" %}})
|
|
||||||
* **Nombre de niveau infini dans le menu**
|
|
||||||
* **Boutons suivant/précédent automatiquement générés pour naviguer entre les items du menu**
|
|
||||||
* [Taille d'image, ombres...]({{%relref "cont/markdown.fr.md#images" %}})
|
|
||||||
* [Fichiers joints]({{%relref "shortcodes/attachments.fr.md" %}})
|
|
||||||
* [Lister les pages filles]({{%relref "shortcodes/children/_index.md" %}})
|
|
||||||
* [Diagrammes Mermaid]({{%relref "shortcodes/mermaid.fr.md" %}}) (flowchart, sequence, gantt)
|
|
||||||
* [Style configurable and variantes de couleurs]({{%relref "basics/style-customization/_index.md"%}})
|
|
||||||
* [Boutons]({{%relref "shortcodes/button.fr.md" %}}), [Messages Astuce/Note/Info/Attention]({{%relref "shortcodes/notice.fr.md" %}}), [Expand]({{%relref "shortcodes/expand.fr.md" %}})
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## Contribuer à cette documentation
|
|
||||||
|
|
||||||
N'hésitez pas à mettre à jour ce contenu en cliquant sur le lien **Modifier cette page** en haut de chaque page, et créer la Pull Request associée.
|
|
||||||
|
|
||||||
{{% notice info %}}
|
|
||||||
Votre modification sera déployée automatiquement quand elle sera mergée.
|
|
||||||
{{% /notice %}}
|
|
||||||
|
|
||||||
## Site de documentation
|
|
||||||
|
|
||||||
Cette documentation statique a été générée avec Hugo avec une simple commande : `hugo -t hugo-theme-learn` -- le code source est [disponible sur Github](https://github.com/matcornic/hugo-theme-learn)
|
|
||||||
|
|
||||||
{{% notice note %}}
|
|
||||||
Le site est auomatiquement publié et hébergé par [Netlify](https://www.netlify.com/). Plus d'infos sur le [déploiement de site Hugo avec Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)(En anglais)
|
|
||||||
{{% /notice %}}
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
---
|
|
||||||
title: Basics
|
|
||||||
weight: 5
|
|
||||||
pre: "<b>1. </b>"
|
|
||||||
chapter: true
|
|
||||||
---
|
|
||||||
|
|
||||||
### Chapter 1
|
|
||||||
|
|
||||||
# Basics
|
|
||||||
|
|
||||||
Discover what this Hugo theme is all about and the core-concepts behind it.
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
---
|
|
||||||
title: Démarrage
|
|
||||||
weight: 5
|
|
||||||
pre: "<b>1. </b>"
|
|
||||||
chapter: true
|
|
||||||
---
|
|
||||||
|
|
||||||
### Chapitre 1
|
|
||||||
|
|
||||||
# Démarrage
|
|
||||||
|
|
||||||
Découvrez comment utiliser ce thème Hugo et apprenez en les concepts
|
|
||||||
@@ -1,54 +0,0 @@
|
|||||||
---
|
|
||||||
date: 2016-04-09T16:50:16+02:00
|
|
||||||
title: Configuration
|
|
||||||
weight: 20
|
|
||||||
---
|
|
||||||
|
|
||||||
## Global site parameters
|
|
||||||
|
|
||||||
On top of [Hugo global configuration](https://gohugo.io/overview/configuration/), **Hugo-theme-learn** lets you define the following parameters in your `config.toml` (here, values are default).
|
|
||||||
|
|
||||||
Note that some of these parameters are explained in details in other sections of this documentation.
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[params]
|
|
||||||
# Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page.
|
|
||||||
# Useful to give opportunity to people to create merge request for your doc.
|
|
||||||
# See the config.toml file from this documentation site to have an example.
|
|
||||||
editURL = ""
|
|
||||||
# Author of the site, will be used in meta information
|
|
||||||
author = ""
|
|
||||||
# Description of the site, will be used in meta information
|
|
||||||
description = ""
|
|
||||||
# Shows a checkmark for visited pages on the menu
|
|
||||||
showVisitedLinks = false
|
|
||||||
# Disable search function. It will hide search bar
|
|
||||||
disableSearch = false
|
|
||||||
# Javascript and CSS cache are automatically busted when new version of site is generated.
|
|
||||||
# Set this to true to disable this behavior (some proxies don't handle well this optimization)
|
|
||||||
disableAssetsBusting = false
|
|
||||||
# Set this to true to disable copy-to-clipboard button for inline code.
|
|
||||||
disableInlineCopyToClipBoard = false
|
|
||||||
# A title for shortcuts in menu is set by default. Set this to true to disable it.
|
|
||||||
disableShortcutsTitle = false
|
|
||||||
# When using mulitlingual website, disable the switch language button.
|
|
||||||
disableLanguageSwitchingButton = false
|
|
||||||
# Order sections in menu by "weight" or "title". Default to "weight"
|
|
||||||
ordersectionsby = "weight"
|
|
||||||
# Change default color scheme with a variant one. Can be "red", "blue", "green".
|
|
||||||
themeVariant = ""
|
|
||||||
```
|
|
||||||
|
|
||||||
## Activate search
|
|
||||||
|
|
||||||
If not already present, add the follow lines in the same `config.toml` file.
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[outputs]
|
|
||||||
home = [ "HTML", "RSS", "JSON"]
|
|
||||||
```
|
|
||||||
|
|
||||||
Learn theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine.
|
|
||||||
|
|
||||||
> Hugo generate lunrjs index.json at the root of public folder.
|
|
||||||
> When you build the site with hugo server, hugo generates it internally and of course it don’t show up in the filesystem
|
|
||||||
@@ -1,54 +0,0 @@
|
|||||||
---
|
|
||||||
date: 2016-04-09T16:50:16+02:00
|
|
||||||
title: Configuration
|
|
||||||
weight: 20
|
|
||||||
---
|
|
||||||
|
|
||||||
## Paramètres globaux du site
|
|
||||||
|
|
||||||
En plus de la [configuration globale d'Hugo](https://gohugo.io/overview/configuration/), **Hugo-theme-learn** vous permet de définir les paramètres suivant dans votre fichier `config.toml` (ci-dessous sont affichées les valeurs par défaut).
|
|
||||||
|
|
||||||
Notez que certains de ces paramètres sont expliqués en détails dans d'autres sections de cette documentation.
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[params]
|
|
||||||
# L'URL préfixe pour éditer la page courante. Ce paramètre affichera un bouton "Modifier cette page" on haut de de chacune des pages.
|
|
||||||
# Pratique pour donner les possibilité à vos utilisateurs de créer une merge request pour votre doc.
|
|
||||||
# Allez voir le fichier config.toml de cette documentation pour avoir un exemple.
|
|
||||||
editURL = ""
|
|
||||||
# Autheur du site, est utilisé dans les informations meta
|
|
||||||
author = ""
|
|
||||||
# Description du site, est utilisé dans les informations meta
|
|
||||||
description = ""
|
|
||||||
# Affiche une icône lorsque la page a été visitée
|
|
||||||
showVisitedLinks = false
|
|
||||||
# Désactive la fonction de recherche. Une valeur à true cache la barre de recherche.
|
|
||||||
disableSearch = false
|
|
||||||
# Par défaut, le cache Javascript et CSS est automatiquement vidé lorsqu'une nouvelle version du site est générée.
|
|
||||||
# Utilisez ce paramètre lorsque vous voulez désactiver ce comportement (c'est parfois incompatible avec certains proxys)
|
|
||||||
disableAssetsBusting = false
|
|
||||||
# Utilisez ce paramètre pour désactiver le bouton copy-to-clipboard pour le code formatté sur une ligne.
|
|
||||||
disableInlineCopyToClipBoard = false
|
|
||||||
# Un titre est défini par défaut lorsque vous utilisez un raccourci dans le menu. Utilisez ce paramètre pour le cacher.
|
|
||||||
disableShortcutsTitle = false
|
|
||||||
# Quand vous utilisez un site multi-langue, utilisez ce paramètre pour désactiver le bouton de changement de langue.
|
|
||||||
disableLanguageSwitchingButton = false
|
|
||||||
# Ordonne les sections dans menu par poids ("weight") ou titre ("title"). Défaut à "weight"
|
|
||||||
ordersectionsby = "weight"
|
|
||||||
# Utilisez ce paramètre pour modifier le schéma de couleur du site. Les valeurs par défaut sont "red", "blue", "green".
|
|
||||||
themeVariant = ""
|
|
||||||
```
|
|
||||||
|
|
||||||
## Activer la recherche {#activer-recherche}
|
|
||||||
|
|
||||||
Si ce n'est pas déjà présent, ajoutez les lignes suivantes dans le fichier `config.toml`.
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[outputs]
|
|
||||||
home = [ "HTML", "RSS", "JSON"]
|
|
||||||
```
|
|
||||||
|
|
||||||
Le thème *Learn* utilise les dernières amélioraions d'Hugo pour générer un fichier d'index JSON, prêt à être consommé par le moteur de recherche lunr.js.
|
|
||||||
|
|
||||||
> Hugo génère lunrjs index.json à la racine du dossier `public`.
|
|
||||||
> Quand vous générez le site avec `hugo server`, Hugo génère le fichier en mémoire, il n'est donc pas disponible sur le disque.
|
|
||||||
@@ -1,102 +0,0 @@
|
|||||||
---
|
|
||||||
title: Installation
|
|
||||||
weight: 15
|
|
||||||
---
|
|
||||||
|
|
||||||
The following steps are here to help you initialize your new website. If you don't know Hugo at all, we strongly suggest you to train by following this [great documentation for beginners](https://gohugo.io/overview/quickstart/).
|
|
||||||
|
|
||||||
## Create your project
|
|
||||||
|
|
||||||
Hugo provides a `new` command to create a new website.
|
|
||||||
|
|
||||||
```
|
|
||||||
hugo new site <new_project>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Install the theme
|
|
||||||
|
|
||||||
Install the **Hugo-theme-learn** theme by following [this documentation](https://gohugo.io/themes/installing/)
|
|
||||||
|
|
||||||
The theme's repository is: https://github.com/matcornic/hugo-theme-learn.git
|
|
||||||
|
|
||||||
Alternatively, you can [download the theme as .zip](https://github.com/matcornic/hugo-theme-learn/archive/master.zip) file and extract it in the themes directory
|
|
||||||
|
|
||||||
## Basic configuration
|
|
||||||
|
|
||||||
When building the website, you can set a theme by using `--theme` option. We suggest you to edit your configuration file and set the theme by default. By the way, add requirements for search functionnality to be enabled.
|
|
||||||
|
|
||||||
```toml
|
|
||||||
# Change the default theme to be use when building the site with Hugo
|
|
||||||
theme = "hugo-theme-learn"
|
|
||||||
|
|
||||||
# For search functionnality
|
|
||||||
[outputs]
|
|
||||||
home = [ "HTML", "RSS", "JSON"]
|
|
||||||
```
|
|
||||||
|
|
||||||
## Create your first chapter page
|
|
||||||
|
|
||||||
Chapters are pages containg other child pages. It has a special layout style and usually just contains a _chapter name_, the _title_ and a _brief abstract_ of the section.
|
|
||||||
|
|
||||||
```
|
|
||||||
### Chapter 1
|
|
||||||
|
|
||||||
# Basics
|
|
||||||
|
|
||||||
Discover what this Hugo theme is all about and the core-concepts behind it.
|
|
||||||
```
|
|
||||||
|
|
||||||
renders as
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
**Hugo-theme-learn** provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following command
|
|
||||||
|
|
||||||
```
|
|
||||||
hugo new --kind chapter basics/_index.md
|
|
||||||
```
|
|
||||||
|
|
||||||
By opening the given file, you should see the property `chapter=true` on top, meaning this page is a _chapter_.
|
|
||||||
|
|
||||||
By default all chapters and pages are created as draft. If you want to render these pages, remove the property `draft: true` from the metadata.
|
|
||||||
|
|
||||||
## Create your first content pages
|
|
||||||
|
|
||||||
Then, create content pages inside the previous chapter. Here are two ways to create content in the chapter :
|
|
||||||
|
|
||||||
```
|
|
||||||
hugo new basics/first-content.md
|
|
||||||
hugo new basics/second-content/_index.md
|
|
||||||
```
|
|
||||||
|
|
||||||
Feel free to edit thoses files by adding some sample content and replacing `title` value in the beginning of the files.
|
|
||||||
|
|
||||||
## Launching the website locally
|
|
||||||
|
|
||||||
Launch the following command:
|
|
||||||
|
|
||||||
```
|
|
||||||
hugo serve
|
|
||||||
```
|
|
||||||
|
|
||||||
Go to `http://localhost:1313`
|
|
||||||
|
|
||||||
You should notice three things:
|
|
||||||
|
|
||||||
1. You have a left **Basics** menu, containing two submenus with names equals to `title` properties in previously created files.
|
|
||||||
2. The home page explains you to how to customize it. Follow the instructions.
|
|
||||||
3. With `hugo serve` command, the page refresh as soon as you save a file. Neat !
|
|
||||||
|
|
||||||
## Build the website
|
|
||||||
|
|
||||||
When your site is ready to deploy, launch the following command:
|
|
||||||
|
|
||||||
```
|
|
||||||
hugo
|
|
||||||
```
|
|
||||||
|
|
||||||
A `public` folder has been generated, containing all statics content and assets for your website. It can now be deployed on any web server !
|
|
||||||
|
|
||||||
{{% notice note %}}
|
|
||||||
This website can be automatically published and hosted with [Netlify](https://www.netlify.com/) (Read more about [Automated HUGO deployments with Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)). Alternatively, you can use [Github pages](https://gohugo.io/hosting-and-deployment/hosting-on-github/)
|
|
||||||
{{% /notice %}}
|
|
||||||
@@ -1,100 +0,0 @@
|
|||||||
---
|
|
||||||
title: Installation
|
|
||||||
weight: 15
|
|
||||||
---
|
|
||||||
|
|
||||||
Les étapes suivantes sont là pour vous aider à initialiser votre site. Si vous ne connaissez pas du tout Hugo, il est fortement conseillé de vous entrainer en suivant ce [super tuto pour débutants](https://gohugo.io/overview/quickstart/).
|
|
||||||
|
|
||||||
## Créer votre projet
|
|
||||||
|
|
||||||
Hugo fournit une commande `new` pour créer un nouveau site.
|
|
||||||
|
|
||||||
```
|
|
||||||
hugo new site <new_project>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Installer le thème
|
|
||||||
|
|
||||||
Installer le thème **Hugo-theme-learn** en suivant [cette documentation](https://gohugo.io/themes/installing/)
|
|
||||||
|
|
||||||
Le repo du thème est : https://github.com/matcornic/hugo-theme-learn.git
|
|
||||||
|
|
||||||
Sinon, vous pouvez [télécharger le thème sous forme d'un fichier .zip](https://github.com/matcornic/hugo-theme-learn/archive/master.zip) et extrayez le dans votre dossier de thèmes.
|
|
||||||
|
|
||||||
## Configuration simple
|
|
||||||
|
|
||||||
Lorsque vous générez votre site, vous pouvez définir un thème en utilisant l'option `--theme`. Il est conseillé de modifier votre fichier de configuration `config.toml` and définir votre thème par défaut. En passant, ajoutez les prérequis à l'utilisation de la fonctionnalité de recherche.
|
|
||||||
|
|
||||||
```toml
|
|
||||||
# Modifiez le thème pour qu'il soit utilisé par défaut à chaque génération de site.
|
|
||||||
theme = "hugo-theme-learn"
|
|
||||||
|
|
||||||
# Pour la fonctionnalité de recherche
|
|
||||||
[outputs]
|
|
||||||
home = [ "HTML", "RSS", "JSON"]
|
|
||||||
```
|
|
||||||
|
|
||||||
## Créer votre première page chapitre
|
|
||||||
|
|
||||||
Les *chapitres* sont des pages contenant d'autre pages filles. Elles ont un affichage spécial et contiennent habituellement juste un _nom_ de chapitre, le _titre_ et un _résumé_ de la section.
|
|
||||||
|
|
||||||
```
|
|
||||||
### Chapitre 1
|
|
||||||
|
|
||||||
# Démarrage
|
|
||||||
|
|
||||||
Découvrez comment utiliser ce thème Hugo et apprenez en les concepts
|
|
||||||
```
|
|
||||||
|
|
||||||
s'affiche comme
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
**Hugo-theme-learn** fournit des archétypes pour créer des squelettes pour votre site. Commencez par créer votre premier chapitre avec la commande suivante:
|
|
||||||
|
|
||||||
```
|
|
||||||
hugo new --kind chapter basics/_index.md
|
|
||||||
```
|
|
||||||
|
|
||||||
En ouvrant le fichier généré, vous devriez voir la propriété `chapter=true` en haut, paramètre quit définit que le page est un _chapitre_.
|
|
||||||
|
|
||||||
## Créer votre première page
|
|
||||||
|
|
||||||
Puis, créez votre premier page dans le chapitre précédent. Pour ce faire, il existe deux possibilités :
|
|
||||||
|
|
||||||
```
|
|
||||||
hugo new basics/first-content.md
|
|
||||||
hugo new basics/second-content/_index.md
|
|
||||||
```
|
|
||||||
|
|
||||||
N'hésitez pas à éditer ces fichiers en ajoutant des exemple de contenu et en remplaçant le paramètre `title` au début du fichier.
|
|
||||||
|
|
||||||
## Lancer le site localement
|
|
||||||
|
|
||||||
Lancez la commande suivante :
|
|
||||||
|
|
||||||
```
|
|
||||||
hugo serve
|
|
||||||
```
|
|
||||||
|
|
||||||
Se rendre sur `http://localhost:1313`
|
|
||||||
|
|
||||||
Vous devriez voir trois choses:
|
|
||||||
|
|
||||||
1. Vous avez un menu **Basics** à gauche, qui contient deux sous-menu avec des noms égal au paramètre `title` des fichiers précédemment générés.
|
|
||||||
2. La page d'accueil vous explique comment la modifier. Suivez les instructions.
|
|
||||||
3. Avec la commande `hugo serve`, la page se rafraichit automatiquement à chaque fois que vous sauvegardez. Super !
|
|
||||||
|
|
||||||
## Générez le site
|
|
||||||
|
|
||||||
Quand votre site est prêt à être déployé, lancez la commande suivante:
|
|
||||||
|
|
||||||
```
|
|
||||||
hugo
|
|
||||||
```
|
|
||||||
|
|
||||||
Un dossier `public` a été généré. Il contient tout le contenu statique et les ressources nécessaires pour votre site. Votre site peut maintenant être déployé en utilisant n'importe quel serveur !
|
|
||||||
|
|
||||||
{{% notice note %}}
|
|
||||||
Ce site peut être automatiquement publié et hébergé avec [Netlify](https://www.netlify.com/) ([Plus d'infos](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)). Sinon, vous pouvez utiliser les [Github pages](https://gohugo.io/hosting-and-deployment/hosting-on-github/)
|
|
||||||
{{% /notice %}}
|
|
||||||
|
Before Width: | Height: | Size: 86 KiB |
@@ -1,11 +0,0 @@
|
|||||||
---
|
|
||||||
title: Requirements
|
|
||||||
weight: 10
|
|
||||||
disableToc: true
|
|
||||||
---
|
|
||||||
|
|
||||||
Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements.
|
|
||||||
|
|
||||||
Just download latest version of [Hugo binary (> 0.25)](https://gohugo.io/getting-started/installing/) for your OS (Windows, Linux, Mac) : it's that simple.
|
|
||||||
|
|
||||||

|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
---
|
|
||||||
title: Prérequis
|
|
||||||
weight: 10
|
|
||||||
disableToc: true
|
|
||||||
---
|
|
||||||
|
|
||||||
Grâce à la simplicité d'Hugo, cette page est vide car il n'y a quasi pas de prérequis pour utiliser le thème.
|
|
||||||
|
|
||||||
Téléchargez la dernière version du [binaire Hugo (> 0.25)](https://gohugo.io/getting-started/installing/) pour votre Système d'exploitation (Windows, Linux, Mac) : et c'est tout !
|
|
||||||
|
|
||||||

|
|
||||||
|
Before Width: | Height: | Size: 1.4 MiB |
@@ -1,194 +0,0 @@
|
|||||||
---
|
|
||||||
date: 2016-04-09T16:50:16+02:00
|
|
||||||
title: Style customization
|
|
||||||
weight: 25
|
|
||||||
---
|
|
||||||
|
|
||||||
**Hugo-theme-learn** has been built to be as configurable as possible by defining multiple [partials](https://gohugo.io/templates/partials/)
|
|
||||||
|
|
||||||
In `themes/hugo-theme-learn/layouts/partials/`, you will find all the partials defined for this theme. If you need to overwrite something, don't change the code directly. Instead [follow this page](https://gohugo.io/themes/customizing/). You'd create a new partial in the `layouts/partials` folder of your local project. This partial will have the priority.
|
|
||||||
|
|
||||||
This theme defines the following partials :
|
|
||||||
|
|
||||||
- *header*: the header of the content page (contains the breadcrumbs). _Not meant to be overwritten_
|
|
||||||
- *custom-header*: custom headers in page. Meant to be overwritten when adding CSS imports. Don't forget to include `style` HTML tag directive in your file
|
|
||||||
- *footer*: the footer of the content page (contains the arrows). _Not meant to be overwritten_
|
|
||||||
- *custom-footer*: custom footer in page. Meant to be overwritten when adding Javacript. Don't forget to include `javascript` HTML tag directive in your file
|
|
||||||
- *favicon*: the favicon
|
|
||||||
- *logo*: the logo, on top left hand corner.
|
|
||||||
- *meta*: HTML meta tags, if you want to change default behavior
|
|
||||||
- *menu*: left menu. _Not meant to be overwritten_
|
|
||||||
- *menu-footer*: footer of the the left menu
|
|
||||||
- *search*: search box
|
|
||||||
- *toc*: table of contents
|
|
||||||
|
|
||||||
## Change the logo
|
|
||||||
|
|
||||||
Create a new file in `layouts/partials/` named `logo.html`. Then write any HTML you want.
|
|
||||||
You could use an `img` HTML tag and reference an image created under the *static* folder, or you could paste a SVG definition !
|
|
||||||
|
|
||||||
{{% notice note %}}
|
|
||||||
The size of the logo will adapt automatically
|
|
||||||
{{% /notice %}}
|
|
||||||
|
|
||||||
## Change the favicon
|
|
||||||
|
|
||||||
If your favicon is a png, just drop off your image in your local `static/images/` folder and names it `favicon.png`
|
|
||||||
|
|
||||||
If you need to change this default behavior, create a new file in `layouts/partials/` named `favicon.html`. Then write something like this:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<link rel="shortcut icon" href="/images/favicon.png" type="image/x-icon" />
|
|
||||||
```
|
|
||||||
|
|
||||||
## Change default colors {#theme-variant}
|
|
||||||
|
|
||||||
**Hugo Learn theme** let you choose between 3 native color scheme variants, but feel free to add one yourself ! Default color scheme is based on [Grav Learn Theme](https://learn.getgrav.org/).
|
|
||||||
|
|
||||||
### Red variant
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[params]
|
|
||||||
# Change default color scheme with a variant one. Can be "red", "blue", "green".
|
|
||||||
themeVariant = "red"
|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
### Blue variant
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[params]
|
|
||||||
# Change default color scheme with a variant one. Can be "red", "blue", "green".
|
|
||||||
themeVariant = "blue"
|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
### Green variant
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[params]
|
|
||||||
# Change default color scheme with a variant one. Can be "red", "blue", "green".
|
|
||||||
themeVariant = "green"
|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
### 'Yours‘ variant
|
|
||||||
|
|
||||||
First, create a new CSS file in your local `static/css` folder prefixed by `theme` (e.g. with _mine_ theme `static/css/theme-mine.css`). Copy the following content and modify colors in CSS variables.
|
|
||||||
|
|
||||||
```css
|
|
||||||
|
|
||||||
:root{
|
|
||||||
|
|
||||||
--MAIN-TEXT-color:#323232; /* Color of text by default */
|
|
||||||
--MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5 */
|
|
||||||
--MAIN-LINK-color:#1C90F3; /* Color of links */
|
|
||||||
--MAIN-LINK-HOVER-color:#167ad0; /* Color of hovered links */
|
|
||||||
--MAIN-ANCHOR-color: #1C90F3; /* color of anchors on titles */
|
|
||||||
|
|
||||||
--MENU-HEADER-BG-color:#1C90F3; /* Background color of menu header */
|
|
||||||
--MENU-HEADER-BORDER-color:#33a1ff; /*Color of menu header border */
|
|
||||||
|
|
||||||
--MENU-SEARCH-BG-color:#167ad0; /* Search field background color (by default borders + icons) */
|
|
||||||
--MENU-SEARCH-BOX-color: #33a1ff; /* Override search field border color */
|
|
||||||
--MENU-SEARCH-BOX-ICONS-color: #a1d2fd; /* Override search field icons color */
|
|
||||||
|
|
||||||
--MENU-SECTIONS-ACTIVE-BG-color:#20272b; /* Background color of the active section and its childs */
|
|
||||||
--MENU-SECTIONS-BG-color:#252c31; /* Background color of other sections */
|
|
||||||
--MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */
|
|
||||||
--MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */
|
|
||||||
--MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */
|
|
||||||
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */
|
|
||||||
|
|
||||||
--MENU-VISITED-color: #33a1ff; /* Color of 'page visited' icons in menu */
|
|
||||||
--MENU-SECTION-HR-color: #20272b; /* Color of <hr> separator in menu */
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
body {
|
|
||||||
color: var(--MAIN-TEXT-color) !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
textarea:focus, input[type="email"]:focus, input[type="number"]:focus, input[type="password"]:focus, input[type="search"]:focus, input[type="tel"]:focus, input[type="text"]:focus, input[type="url"]:focus, input[type="color"]:focus, input[type="date"]:focus, input[type="datetime"]:focus, input[type="datetime-local"]:focus, input[type="month"]:focus, input[type="time"]:focus, input[type="week"]:focus, select[multiple=multiple]:focus {
|
|
||||||
border-color: none;
|
|
||||||
box-shadow: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
h2, h3, h4, h5 {
|
|
||||||
color: var(--MAIN-TITLES-TEXT-color) !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
a {
|
|
||||||
color: var(--MAIN-LINK-color);
|
|
||||||
}
|
|
||||||
|
|
||||||
.anchor {
|
|
||||||
color: var(--MAIN-ANCHOR-color);
|
|
||||||
}
|
|
||||||
|
|
||||||
a:hover {
|
|
||||||
color: var(--MAIN-LINK-HOVER-color);
|
|
||||||
}
|
|
||||||
|
|
||||||
#sidebar ul li.visited > a .read-icon {
|
|
||||||
color: var(--MENU-VISITED-color);
|
|
||||||
}
|
|
||||||
|
|
||||||
#body a.highlight:after {
|
|
||||||
display: block;
|
|
||||||
content: "";
|
|
||||||
height: 1px;
|
|
||||||
width: 0%;
|
|
||||||
-webkit-transition: width 0.5s ease;
|
|
||||||
-moz-transition: width 0.5s ease;
|
|
||||||
-ms-transition: width 0.5s ease;
|
|
||||||
transition: width 0.5s ease;
|
|
||||||
background-color: var(--MAIN-HOVER-color);
|
|
||||||
}
|
|
||||||
#sidebar {
|
|
||||||
background-color: var(--MENU-SECTIONS-BG-color);
|
|
||||||
}
|
|
||||||
#sidebar #header-wrapper {
|
|
||||||
background: var(--MENU-HEADER-BG-color);
|
|
||||||
color: var(--MENU-SEARCH-BOX-color);
|
|
||||||
border-color: var(--MENU-HEADER-BORDER-color);
|
|
||||||
}
|
|
||||||
#sidebar .searchbox {
|
|
||||||
border-color: var(--MENU-SEARCH-BOX-color);
|
|
||||||
background: var(--MENU-SEARCH-BG-color);
|
|
||||||
}
|
|
||||||
#sidebar ul.topics > li.parent, #sidebar ul.topics > li.active {
|
|
||||||
background: var(--MENU-SECTIONS-ACTIVE-BG-color);
|
|
||||||
}
|
|
||||||
#sidebar .searchbox * {
|
|
||||||
color: var(--MENU-SEARCH-BOX-ICONS-color);
|
|
||||||
}
|
|
||||||
|
|
||||||
#sidebar a {
|
|
||||||
color: var(--MENU-SECTIONS-LINK-color);
|
|
||||||
}
|
|
||||||
|
|
||||||
#sidebar a:hover {
|
|
||||||
color: var(--MENU-SECTIONS-LINK-HOVER-color);
|
|
||||||
}
|
|
||||||
|
|
||||||
#sidebar ul li.active > a {
|
|
||||||
background: var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color);
|
|
||||||
color: var(--MENU-SECTION-ACTIVE-CATEGORY-color) !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
#sidebar hr {
|
|
||||||
border-color: var(--MENU-SECTION-HR-color);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Then, set the `themeVariant` value with the name of your custom theme file. That's it !
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[params]
|
|
||||||
# Change default color scheme with a variant one. Can be "red", "blue", "green".
|
|
||||||
themeVariant = "mine"
|
|
||||||
```
|
|
||||||
@@ -1,194 +0,0 @@
|
|||||||
---
|
|
||||||
date: 2016-04-09T16:50:16+02:00
|
|
||||||
title: Personnalisation du style
|
|
||||||
weight: 25
|
|
||||||
---
|
|
||||||
|
|
||||||
**Hugo-theme-learn** a été conçu pour être aussi configurable que possible en définissant plusieurs [partials](https://gohugo.io/templates/partials/)
|
|
||||||
|
|
||||||
Dans `themes/hugo-theme-learn/layouts/partials/`, vous pourrez trouver tous les *partials* définis pour ce thème. Si vous avez besoin d'écraser quelque chose, ne modifiez pas le code directement. A la place, [suivez cette page](https://gohugo.io/themes/customizing/). Vous créerez alors un nouveau *partial* dans le dossier `layouts/partials` de votre site local. Ce *partial* aura la priorité.
|
|
||||||
|
|
||||||
Ce thème définit les *partials* suivant :
|
|
||||||
|
|
||||||
- *header*: l'en-tête de la page page (contient le fil d'Ariane). _Pas voué à être écrasé_
|
|
||||||
- *custom-header*: En-tête personnalisé. Voué à être écrasé quand vous ajoutez des imports CSS. N'oubliez pas d'inclure la balise HTML `style` dans votre fichier
|
|
||||||
- *footer*: le pied-de-page de la page (contains les flèches). _Pas voué à être écrasé_
|
|
||||||
- *custom-footer*: Pied-de-page personnalisé. Voué à être écrasé quand vous ajoutez du Javascript. N'oubliez pas d'inclure la balise HTML `javascript` dans votre fichier
|
|
||||||
- *favicon*: le favicon
|
|
||||||
- *logo*: le logo, affiché un haut à gauche.
|
|
||||||
- *meta*: les balises HTML meta, que vous pouvez écraser sans problème.
|
|
||||||
- *menu*: Le menu à gauche. _Pas voué à être écrasé_
|
|
||||||
- *menu-footer*: Le pied-de-page du menu
|
|
||||||
- *search*: le champ de recherche
|
|
||||||
- *toc*: le sommaire
|
|
||||||
|
|
||||||
## Changer le logo
|
|
||||||
|
|
||||||
Créez un nouveau fichier dans `layouts/partials/`, nommé `logo.html`. Puis, écrivez le code HTML voulu.
|
|
||||||
Vous pourriez utiliser une balise HTML `img` et référencer une image créée dans le dossier *static*, voire même y coller un cod SVG !
|
|
||||||
|
|
||||||
{{% notice note %}}
|
|
||||||
La taille du logo va s'adapter automatiquement
|
|
||||||
{{% /notice %}}
|
|
||||||
|
|
||||||
## Changer le favicon
|
|
||||||
|
|
||||||
Si votre favicon est un png, déposez votre image dans votre dossier local `static/images/` et nommez le `favicon.png`
|
|
||||||
|
|
||||||
Si vous avez besoin de changer ce comportement par défaut, créer un nouveau fichier dans `layouts/partials/` et nommez le `favicon.html`. Puis ajoutez quelque chose comme:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<link rel="shortcut icon" href="/images/favicon.png" type="image/x-icon" />
|
|
||||||
```
|
|
||||||
|
|
||||||
## Changer les couleurs par défaut {#theme-variant}
|
|
||||||
|
|
||||||
**Hugo Learn theme** vous permet de choisir nativement entre 3 schéma de couleurs, mais n'hésitez pas à en ajouter d'autres ! Les couleurs par défaut sont celles de [Grav Learn Theme](https://learn.getgrav.org/).
|
|
||||||
|
|
||||||
### Variante rouge
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[params]
|
|
||||||
# Modifier le schéma de couleur par défaut. Peut être "red", "blue", "green".
|
|
||||||
themeVariant = "red"
|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
### Variante bleue
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[params]
|
|
||||||
# Modifier le schéma de couleur par défaut. Peut être "red", "blue", "green".
|
|
||||||
themeVariant = "blue"
|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
### Variante verte
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[params]
|
|
||||||
# Modifier le schéma de couleur par défaut. Peut être "red", "blue", "green".
|
|
||||||
themeVariant = "green"
|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
### Votre variante
|
|
||||||
|
|
||||||
Premièrement, créez un nouveau fichier CSS dans votre dossier `static/css`, préfixé par `theme` (ex: avec le theme_lemien_ `static/css/theme-lemien.css`). Copiez le contenu suivant et modifiez les couleurs dans les variables CSS.
|
|
||||||
|
|
||||||
```css
|
|
||||||
|
|
||||||
:root{
|
|
||||||
|
|
||||||
--MAIN-TEXT-color:#323232; /* Color of text by default */
|
|
||||||
--MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5 */
|
|
||||||
--MAIN-LINK-color:#1C90F3; /* Color of links */
|
|
||||||
--MAIN-LINK-HOVER-color:#167ad0; /* Color of hovered links */
|
|
||||||
--MAIN-ANCHOR-color: #1C90F3; /* color of anchors on titles */
|
|
||||||
|
|
||||||
--MENU-HEADER-BG-color:#1C90F3; /* Background color of menu header */
|
|
||||||
--MENU-HEADER-BORDER-color:#33a1ff; /*Color of menu header border */
|
|
||||||
|
|
||||||
--MENU-SEARCH-BG-color:#167ad0; /* Search field background color (by default borders + icons) */
|
|
||||||
--MENU-SEARCH-BOX-color: #33a1ff; /* Override search field border color */
|
|
||||||
--MENU-SEARCH-BOX-ICONS-color: #a1d2fd; /* Override search field icons color */
|
|
||||||
|
|
||||||
--MENU-SECTIONS-ACTIVE-BG-color:#20272b; /* Background color of the active section and its childs */
|
|
||||||
--MENU-SECTIONS-BG-color:#252c31; /* Background color of other sections */
|
|
||||||
--MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */
|
|
||||||
--MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */
|
|
||||||
--MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */
|
|
||||||
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */
|
|
||||||
|
|
||||||
--MENU-VISITED-color: #33a1ff; /* Color of 'page visited' icons in menu */
|
|
||||||
--MENU-SECTION-HR-color: #20272b; /* Color of <hr> separator in menu */
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
body {
|
|
||||||
color: var(--MAIN-TEXT-color) !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
textarea:focus, input[type="email"]:focus, input[type="number"]:focus, input[type="password"]:focus, input[type="search"]:focus, input[type="tel"]:focus, input[type="text"]:focus, input[type="url"]:focus, input[type="color"]:focus, input[type="date"]:focus, input[type="datetime"]:focus, input[type="datetime-local"]:focus, input[type="month"]:focus, input[type="time"]:focus, input[type="week"]:focus, select[multiple=multiple]:focus {
|
|
||||||
border-color: none;
|
|
||||||
box-shadow: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
h2, h3, h4, h5 {
|
|
||||||
color: var(--MAIN-TITLES-TEXT-color) !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
a {
|
|
||||||
color: var(--MAIN-LINK-color);
|
|
||||||
}
|
|
||||||
|
|
||||||
.anchor {
|
|
||||||
color: var(--MAIN-ANCHOR-color);
|
|
||||||
}
|
|
||||||
|
|
||||||
a:hover {
|
|
||||||
color: var(--MAIN-LINK-HOVER-color);
|
|
||||||
}
|
|
||||||
|
|
||||||
#sidebar ul li.visited > a .read-icon {
|
|
||||||
color: var(--MENU-VISITED-color);
|
|
||||||
}
|
|
||||||
|
|
||||||
#body a.highlight:after {
|
|
||||||
display: block;
|
|
||||||
content: "";
|
|
||||||
height: 1px;
|
|
||||||
width: 0%;
|
|
||||||
-webkit-transition: width 0.5s ease;
|
|
||||||
-moz-transition: width 0.5s ease;
|
|
||||||
-ms-transition: width 0.5s ease;
|
|
||||||
transition: width 0.5s ease;
|
|
||||||
background-color: var(--MAIN-HOVER-color);
|
|
||||||
}
|
|
||||||
#sidebar {
|
|
||||||
background-color: var(--MENU-SECTIONS-BG-color);
|
|
||||||
}
|
|
||||||
#sidebar #header-wrapper {
|
|
||||||
background: var(--MENU-HEADER-BG-color);
|
|
||||||
color: var(--MENU-SEARCH-BOX-color);
|
|
||||||
border-color: var(--MENU-HEADER-BORDER-color);
|
|
||||||
}
|
|
||||||
#sidebar .searchbox {
|
|
||||||
border-color: var(--MENU-SEARCH-BOX-color);
|
|
||||||
background: var(--MENU-SEARCH-BG-color);
|
|
||||||
}
|
|
||||||
#sidebar ul.topics > li.parent, #sidebar ul.topics > li.active {
|
|
||||||
background: var(--MENU-SECTIONS-ACTIVE-BG-color);
|
|
||||||
}
|
|
||||||
#sidebar .searchbox * {
|
|
||||||
color: var(--MENU-SEARCH-BOX-ICONS-color);
|
|
||||||
}
|
|
||||||
|
|
||||||
#sidebar a {
|
|
||||||
color: var(--MENU-SECTIONS-LINK-color);
|
|
||||||
}
|
|
||||||
|
|
||||||
#sidebar a:hover {
|
|
||||||
color: var(--MENU-SECTIONS-LINK-HOVER-color);
|
|
||||||
}
|
|
||||||
|
|
||||||
#sidebar ul li.active > a {
|
|
||||||
background: var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color);
|
|
||||||
color: var(--MENU-SECTION-ACTIVE-CATEGORY-color) !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
#sidebar hr {
|
|
||||||
border-color: var(--MENU-SECTION-HR-color);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Puis, configurez le paramètre `themeVariant` avec le nom de votre variante. C'est tout !
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[params]
|
|
||||||
# Modifier le schéma de couleur par défaut. Peut être "red", "blue", "green".
|
|
||||||
themeVariant = "lemien"
|
|
||||||
```
|
|
||||||
|
Before Width: | Height: | Size: 380 KiB |
|
Before Width: | Height: | Size: 382 KiB |
|
Before Width: | Height: | Size: 381 KiB |
@@ -1,12 +0,0 @@
|
|||||||
---
|
|
||||||
title: Content
|
|
||||||
weight: 10
|
|
||||||
chapter: true
|
|
||||||
pre: "<b>2. </b>"
|
|
||||||
---
|
|
||||||
|
|
||||||
### Chapter 2
|
|
||||||
|
|
||||||
# Content
|
|
||||||
|
|
||||||
Find out how to create and organize your content quickly and intuitively.
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
---
|
|
||||||
title: Contenu
|
|
||||||
weight: 10
|
|
||||||
chapter: true
|
|
||||||
pre: "<b>2. </b>"
|
|
||||||
---
|
|
||||||
|
|
||||||
### Chapitre 2
|
|
||||||
|
|
||||||
# Contenu
|
|
||||||
|
|
||||||
Découvrez comment créer et organiser votre contenu facilement et intuitivement.
|
|
||||||
@@ -1,57 +0,0 @@
|
|||||||
---
|
|
||||||
title: Archetypes
|
|
||||||
weight: 10
|
|
||||||
---
|
|
||||||
|
|
||||||
Using the command: `hugo new [relative new content path]`, you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more : [archetypes](https://gohugo.io/content/archetypes/).
|
|
||||||
|
|
||||||
It is pre-configured skeleton pages with default front matter. Please refer to the documentation for types of page to understand the differences.
|
|
||||||
|
|
||||||
## Chapter {#archetypes-chapter}
|
|
||||||
|
|
||||||
To create a Chapter page, run the following commands
|
|
||||||
|
|
||||||
```
|
|
||||||
hugo new --kind chapter <name>/_index.md
|
|
||||||
```
|
|
||||||
|
|
||||||
It will create a page with predefined Front-Matter:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
+++
|
|
||||||
title = "{{ replace .TranslationBaseName "-" " " | title }}"
|
|
||||||
date = {{ .Date }}
|
|
||||||
weight = 5
|
|
||||||
chapter = true
|
|
||||||
pre = "<b>X. </b>"
|
|
||||||
+++
|
|
||||||
|
|
||||||
### Chapter X
|
|
||||||
|
|
||||||
# Some Chapter title
|
|
||||||
|
|
||||||
Lorem Ipsum.
|
|
||||||
```
|
|
||||||
|
|
||||||
## Default
|
|
||||||
|
|
||||||
To create a default page, run either one of the following commands
|
|
||||||
|
|
||||||
```
|
|
||||||
# Either
|
|
||||||
hugo new <chapter>/<name>/_index.md
|
|
||||||
# Or
|
|
||||||
hugo new <chapter>/<name>.md
|
|
||||||
```
|
|
||||||
|
|
||||||
It will create a page with predefined Front-Matter:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
+++
|
|
||||||
title = "{{ replace .TranslationBaseName "-" " " | title }}"
|
|
||||||
date = {{ .Date }}
|
|
||||||
weight = 5
|
|
||||||
+++
|
|
||||||
|
|
||||||
Lorem Ipsum.
|
|
||||||
```
|
|
||||||
@@ -1,57 +0,0 @@
|
|||||||
---
|
|
||||||
title: Archétypes
|
|
||||||
weight: 10
|
|
||||||
---
|
|
||||||
|
|
||||||
En utilisant la commande: `hugo new [chemin vers nouveau contenu]`, vous pouvez créer un nouveau fichier avec la date et le title automatiquement initialisé. Même si c'est une fonctionnalité intéressante, elle reste limitée pour les auteurs actifs qui ont besoin de mieux : les [archetypes](https://gohugo.io/content/archetypes/).
|
|
||||||
|
|
||||||
Les archétypes sont des squelettes de pages préconfigurées avec un Front Matter par défaut. Merci de vous référer à la documentation pour connaitre les différents types de page.
|
|
||||||
|
|
||||||
## Chapitre {#archetypes-chapter}
|
|
||||||
|
|
||||||
Pour créer un chapitre, lancez les commandes suivantes
|
|
||||||
|
|
||||||
```
|
|
||||||
hugo new --kind chapter <name>/_index.md
|
|
||||||
```
|
|
||||||
|
|
||||||
Cela crééra une page avec le Front Matter suivant:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
+++
|
|
||||||
title = "{{ replace .TranslationBaseName "-" " " | title }}"
|
|
||||||
date = {{ .Date }}
|
|
||||||
weight = 5
|
|
||||||
chapter = true
|
|
||||||
pre = "<b>X. </b>"
|
|
||||||
+++
|
|
||||||
|
|
||||||
### Chapter X
|
|
||||||
|
|
||||||
# Some Chapter title
|
|
||||||
|
|
||||||
Lorem Ipsum.
|
|
||||||
```
|
|
||||||
|
|
||||||
## Défaut
|
|
||||||
|
|
||||||
Pour créer une page classique, lancer l'une des deux commandes suivantes
|
|
||||||
|
|
||||||
```
|
|
||||||
# Soit
|
|
||||||
hugo new <chapter>/<name>/_index.md
|
|
||||||
# Ou
|
|
||||||
hugo new <chapter>/<name>.md
|
|
||||||
```
|
|
||||||
|
|
||||||
Cela crééra une page avec le Front Matter suivant:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
+++
|
|
||||||
title = "{{ replace .TranslationBaseName "-" " " | title }}"
|
|
||||||
date = {{ .Date }}
|
|
||||||
weight = 5
|
|
||||||
+++
|
|
||||||
|
|
||||||
Lorem Ipsum.
|
|
||||||
```
|
|
||||||
@@ -1,78 +0,0 @@
|
|||||||
---
|
|
||||||
date: 2016-04-09T16:50:16+02:00
|
|
||||||
title: Multilingual and i18n
|
|
||||||
weight: 30
|
|
||||||
---
|
|
||||||
|
|
||||||
**Learn theme** is fully compatible with Hugo multilingual mode.
|
|
||||||
|
|
||||||
It provides:
|
|
||||||
|
|
||||||
- Translation strings for default values (English and French). Feel free to contribute !
|
|
||||||
- Automatic menu generation from multilingual content
|
|
||||||
- In-browser language switching
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## Basic configuration
|
|
||||||
|
|
||||||
After learning [how Hugo handle multilingual websites](https://gohugo.io/content-management/multilingual), define your languages in your `config.toml` file.
|
|
||||||
|
|
||||||
For example with current French and English website.
|
|
||||||
|
|
||||||
```toml
|
|
||||||
# English is the default language
|
|
||||||
defaultContentLanguage = "en"
|
|
||||||
# Force to have /en/my-page and /fr/my-page routes, even for default language.
|
|
||||||
defaultContentLanguageInSubdir= true
|
|
||||||
|
|
||||||
[Languages]
|
|
||||||
[Languages.en]
|
|
||||||
title = "Documentation for Hugo Learn Theme"
|
|
||||||
weight = 1
|
|
||||||
languageName = "English"
|
|
||||||
|
|
||||||
[Languages.fr]
|
|
||||||
title = "Documentation du thème Hugo Learn"
|
|
||||||
weight = 2
|
|
||||||
languageName = "Français"
|
|
||||||
```
|
|
||||||
|
|
||||||
Then, for each new page, append the *id* of the language to the file.
|
|
||||||
|
|
||||||
- Single file `my-page.md` is split in two files:
|
|
||||||
- in English: `my-page.en.md`
|
|
||||||
- in French: `my-page.fr.md`
|
|
||||||
- Single file `_index.md` is split in two files:
|
|
||||||
- in English: `_index.en.md`
|
|
||||||
- in French: `_index.fr.md`
|
|
||||||
|
|
||||||
{{% notice info %}}
|
|
||||||
Be aware that only translated pages are displayed in menu. It's not replaced with default language content.
|
|
||||||
{{% /notice %}}
|
|
||||||
|
|
||||||
{{% notice tip %}}
|
|
||||||
Use [slug](https://gohugo.io/content-management/multilingual/#translate-your-content) Front Matter parameter to translate urls too.
|
|
||||||
{{% /notice %}}
|
|
||||||
|
|
||||||
## Overwrite translation strings
|
|
||||||
|
|
||||||
Translations strings are used for common default values used in the theme (*Edit this page* button, *Search placeholder* and so on). Translations are available in french and english but you may use another language or want to override default values.
|
|
||||||
|
|
||||||
To override these values, create a new file in your local i18n folder `i18n/<idlanguage>.toml` and inspire yourself from the theme `themes/hugo-theme-learn/i18n/en.toml`
|
|
||||||
|
|
||||||
By the way, as these translations could be used by other people, please take the time to propose a translation by [making a PR](https://github.com/matcornic/hugo-theme-learn/pulls) to the theme !
|
|
||||||
|
|
||||||
## Disable language switching
|
|
||||||
|
|
||||||
Switching the language in the browser is a great feature, but for some reasons you may want to disable it.
|
|
||||||
|
|
||||||
Just set `disableLanguageSwitchingButton=true` in your `config.toml`
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[params]
|
|
||||||
# When using mulitlingual website, disable the switch language button.
|
|
||||||
disableLanguageSwitchingButton = true
|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
@@ -1,78 +0,0 @@
|
|||||||
---
|
|
||||||
date: 2016-04-09T16:50:16+02:00
|
|
||||||
title: Multi-langue et i18n
|
|
||||||
weight: 30
|
|
||||||
---
|
|
||||||
|
|
||||||
**Learn** est complètement compatible avec le mode multi-langue d'Hugo.
|
|
||||||
|
|
||||||
Il fournit :
|
|
||||||
|
|
||||||
- Des *translation strings* pour les valeurs par défaut utilisées par le thème (Anglais et Français). N'hésitez pas à contribuer !
|
|
||||||
- Génération automatique du menu avec le contenu multi-langue
|
|
||||||
- Modification de la langue dans le navigateur
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## Configuration simple
|
|
||||||
|
|
||||||
Après avoir appris [comment Hugo gère les sites multi-langue](https://gohugo.io/content-management/multilingual), définissez vos langues dans votre fichier `config.toml`.
|
|
||||||
|
|
||||||
Par exemple, pour ce site, avec du contenu en français et en anglais.
|
|
||||||
|
|
||||||
```toml
|
|
||||||
# Anglais est la langue par défaut
|
|
||||||
defaultContentLanguage = "en"
|
|
||||||
# Force d'avoir /en/ma-page et /fr/ma-page routes, même avec la langue par défaut.
|
|
||||||
defaultContentLanguageInSubdir= true
|
|
||||||
|
|
||||||
[Languages]
|
|
||||||
[Languages.en]
|
|
||||||
title = "Documentation for Hugo Learn Theme"
|
|
||||||
weight = 1
|
|
||||||
languageName = "English"
|
|
||||||
|
|
||||||
[Languages.fr]
|
|
||||||
title = "Documentation du thème Hugo Learn"
|
|
||||||
weight = 2
|
|
||||||
languageName = "Français"
|
|
||||||
```
|
|
||||||
|
|
||||||
Puis, pour chaque nouvelle page, ajoutez *l'id* de la langue du fichier.
|
|
||||||
|
|
||||||
- Le fichier `my-page.md` est découpé en deux fichiers :
|
|
||||||
- en anglais : `my-page.en.md`
|
|
||||||
- en français : `my-page.fr.md`
|
|
||||||
- Le fichier `_index.md` est découpé en deux fichiers :
|
|
||||||
- en anglais: `_index.en.md`
|
|
||||||
- en français: `_index.fr.md`
|
|
||||||
|
|
||||||
{{% notice info %}}
|
|
||||||
Attention, seulement les pages traduites sont affichées dans le menu. Le contenu n'est pas remplacé par les pages de la langue par défaut.
|
|
||||||
{{% /notice %}}
|
|
||||||
|
|
||||||
{{% notice tip %}}
|
|
||||||
Utilisez le paramètre du Front Matter [slug](https://gohugo.io/content-management/multilingual/#translate-your-content) pour traduire également les URLs.
|
|
||||||
{{% /notice %}}
|
|
||||||
|
|
||||||
## Surcharger les *translation strings*
|
|
||||||
|
|
||||||
Les *Translations strings* sont utilisées comme valeurs par défaut dans le thème (Bouton *Modifier la page*, Element de subsitution *Recherche*, etc.). Les traductions sont disponibles en français et en anglais mais vous pouvez utiliser n'importe quelle autre langue et surcharger avec vos propres valeurs.
|
|
||||||
|
|
||||||
Pour surcharger ces valeurs, créer un nouveau fichier dans votre dossier i18n local `i18n/<idlanguage>.toml` et inspirez vous du thème `themes/hugo-theme-learn/i18n/en.toml`
|
|
||||||
|
|
||||||
D'ailleurs, ces traductions pour servir à tout le monde, donc svp prenez le temps de [proposer une Pull Request](https://github.com/matcornic/hugo-theme-learn/pulls) !
|
|
||||||
|
|
||||||
## Désactiver le changement de langue
|
|
||||||
|
|
||||||
Vous pouvez changer de langue directement dans le navigateur. C'est une super fonctionnalité, mais vous avez peut-être besoin de la désactiver.
|
|
||||||
|
|
||||||
Pour ce faire, ajouter le paramètre `disableLanguageSwitchingButton=true` dans votre `config.toml`
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[params]
|
|
||||||
# Quand vous utilisez un site en multi-langue, désactive le bouton de changment de langue.
|
|
||||||
disableLanguageSwitchingButton = true
|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
|
Before Width: | Height: | Size: 24 KiB |
@@ -1,663 +0,0 @@
|
|||||||
---
|
|
||||||
date: 2016-04-09T16:50:16+02:00
|
|
||||||
title: Markdown syntax
|
|
||||||
weight: 15
|
|
||||||
---
|
|
||||||
|
|
||||||
{{% notice note %}}
|
|
||||||
This page is a shameful copy of the great [Grav original page](http://learn.getgrav.org/content/markdown).
|
|
||||||
Only difference is information about image customization ([resizing]({{< relref "#resizing-image" >}}), [add CSS classes]({{< relref "#add-css-classes" >}})...)
|
|
||||||
{{% /notice%}}
|
|
||||||
|
|
||||||
Let's face it: Writing content for the Web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.
|
|
||||||
|
|
||||||
**Markdown** is a better way to write **HTML**, without all the complexities and ugliness that usually accompanies it.
|
|
||||||
|
|
||||||
Some of the key benefits are:
|
|
||||||
|
|
||||||
1. Markdown is simple to learn, with minimal extra characters so it's also quicker to write content.
|
|
||||||
2. Less chance of errors when writing in markdown.
|
|
||||||
3. Produces valid XHTML output.
|
|
||||||
4. Keeps the content and the visual display separate, so you cannot mess up the look of your site.
|
|
||||||
5. Write in any text editor or Markdown application you like.
|
|
||||||
6. Markdown is a joy to use!
|
|
||||||
|
|
||||||
John Gruber, the author of Markdown, puts it like this:
|
|
||||||
|
|
||||||
> The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
|
|
||||||
> -- <cite>John Gruber</cite>
|
|
||||||
|
|
||||||
|
|
||||||
Grav ships with built-in support for [Markdown](http://daringfireball.net/projects/markdown/) and [Markdown Extra](https://michelf.ca/projects/php-markdown/extra/). You must enable **Markdown Extra** in your `system.yaml` configuration file
|
|
||||||
|
|
||||||
Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:
|
|
||||||
|
|
||||||
{{% notice info %}}
|
|
||||||
<i class="fa fa-bookmark"></i> Bookmark this page for easy future reference!
|
|
||||||
{{% /notice %}}
|
|
||||||
|
|
||||||
## Headings
|
|
||||||
|
|
||||||
Headings from `h1` through `h6` are constructed with a `#` for each level:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
# h1 Heading
|
|
||||||
## h2 Heading
|
|
||||||
### h3 Heading
|
|
||||||
#### h4 Heading
|
|
||||||
##### h5 Heading
|
|
||||||
###### h6 Heading
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
# h1 Heading
|
|
||||||
## h2 Heading
|
|
||||||
### h3 Heading
|
|
||||||
#### h4 Heading
|
|
||||||
##### h5 Heading
|
|
||||||
###### h6 Heading
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<h1>h1 Heading</h1>
|
|
||||||
<h2>h2 Heading</h2>
|
|
||||||
<h3>h3 Heading</h3>
|
|
||||||
<h4>h4 Heading</h4>
|
|
||||||
<h5>h5 Heading</h5>
|
|
||||||
<h6>h6 Heading</h6>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Comments
|
|
||||||
|
|
||||||
Comments should be HTML compatible
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!--
|
|
||||||
This is a comment
|
|
||||||
-->
|
|
||||||
```
|
|
||||||
Comment below should **NOT** be seen:
|
|
||||||
|
|
||||||
<!--
|
|
||||||
This is a comment
|
|
||||||
-->
|
|
||||||
|
|
||||||
|
|
||||||
## Horizontal Rules
|
|
||||||
|
|
||||||
The HTML `<hr>` element is for creating a "thematic break" between paragraph-level elements. In markdown, you can create a `<hr>` with any of the following:
|
|
||||||
|
|
||||||
* `___`: three consecutive underscores
|
|
||||||
* `---`: three consecutive dashes
|
|
||||||
* `***`: three consecutive asterisks
|
|
||||||
|
|
||||||
renders to:
|
|
||||||
|
|
||||||
___
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
|
|
||||||
## Body Copy
|
|
||||||
|
|
||||||
Body copy written as normal, plain text will be wrapped with `<p></p>` tags in the rendered HTML.
|
|
||||||
|
|
||||||
So this body copy:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
|
|
||||||
```
|
|
||||||
renders to this HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</p>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Emphasis
|
|
||||||
|
|
||||||
### Bold
|
|
||||||
For emphasizing a snippet of text with a heavier font-weight.
|
|
||||||
|
|
||||||
The following snippet of text is **rendered as bold text**.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
**rendered as bold text**
|
|
||||||
```
|
|
||||||
renders to:
|
|
||||||
|
|
||||||
**rendered as bold text**
|
|
||||||
|
|
||||||
and this HTML
|
|
||||||
|
|
||||||
```html
|
|
||||||
<strong>rendered as bold text</strong>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Italics
|
|
||||||
For emphasizing a snippet of text with italics.
|
|
||||||
|
|
||||||
The following snippet of text is _rendered as italicized text_.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
_rendered as italicized text_
|
|
||||||
```
|
|
||||||
|
|
||||||
renders to:
|
|
||||||
|
|
||||||
_rendered as italicized text_
|
|
||||||
|
|
||||||
and this HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<em>rendered as italicized text</em>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### strikethrough
|
|
||||||
In GFM (GitHub flavored Markdown) you can do strikethroughs.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
~~Strike through this text.~~
|
|
||||||
```
|
|
||||||
Which renders to:
|
|
||||||
|
|
||||||
~~Strike through this text.~~
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<del>Strike through this text.</del>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Blockquotes
|
|
||||||
For quoting blocks of content from another source within your document.
|
|
||||||
|
|
||||||
Add `>` before any text you want to quote.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
> **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
> **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
|
|
||||||
|
|
||||||
and this HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<blockquote>
|
|
||||||
<p><strong>Fusion Drive</strong> combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.</p>
|
|
||||||
</blockquote>
|
|
||||||
```
|
|
||||||
|
|
||||||
Blockquotes can also be nested:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
|
|
||||||
Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
|
|
||||||
>> Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor
|
|
||||||
odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
|
|
||||||
Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
|
|
||||||
>> Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor
|
|
||||||
odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
|
|
||||||
|
|
||||||
|
|
||||||
## Notices
|
|
||||||
|
|
||||||
{{% notice note %}}
|
|
||||||
The old mechanism for notices overriding the block quote syntax (`>>>`) has been deprecated. Notices are now handled via a dedicated plugin called [Markdown Notices](https://github.com/getgrav/grav-plugin-markdown-notices)
|
|
||||||
{{% /notice %}}
|
|
||||||
|
|
||||||
|
|
||||||
## Lists
|
|
||||||
|
|
||||||
### Unordered
|
|
||||||
A list of items in which the order of the items does not explicitly matter.
|
|
||||||
|
|
||||||
You may use any of the following symbols to denote bullets for each list item:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
* valid bullet
|
|
||||||
- valid bullet
|
|
||||||
+ valid bullet
|
|
||||||
```
|
|
||||||
|
|
||||||
For example
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
+ Lorem ipsum dolor sit amet
|
|
||||||
+ Consectetur adipiscing elit
|
|
||||||
+ Integer molestie lorem at massa
|
|
||||||
+ Facilisis in pretium nisl aliquet
|
|
||||||
+ Nulla volutpat aliquam velit
|
|
||||||
- Phasellus iaculis neque
|
|
||||||
- Purus sodales ultricies
|
|
||||||
- Vestibulum laoreet porttitor sem
|
|
||||||
- Ac tristique libero volutpat at
|
|
||||||
+ Faucibus porta lacus fringilla vel
|
|
||||||
+ Aenean sit amet erat nunc
|
|
||||||
+ Eget porttitor lorem
|
|
||||||
```
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
+ Lorem ipsum dolor sit amet
|
|
||||||
+ Consectetur adipiscing elit
|
|
||||||
+ Integer molestie lorem at massa
|
|
||||||
+ Facilisis in pretium nisl aliquet
|
|
||||||
+ Nulla volutpat aliquam velit
|
|
||||||
- Phasellus iaculis neque
|
|
||||||
- Purus sodales ultricies
|
|
||||||
- Vestibulum laoreet porttitor sem
|
|
||||||
- Ac tristique libero volutpat at
|
|
||||||
+ Faucibus porta lacus fringilla vel
|
|
||||||
+ Aenean sit amet erat nunc
|
|
||||||
+ Eget porttitor lorem
|
|
||||||
|
|
||||||
And this HTML
|
|
||||||
|
|
||||||
```html
|
|
||||||
<ul>
|
|
||||||
<li>Lorem ipsum dolor sit amet</li>
|
|
||||||
<li>Consectetur adipiscing elit</li>
|
|
||||||
<li>Integer molestie lorem at massa</li>
|
|
||||||
<li>Facilisis in pretium nisl aliquet</li>
|
|
||||||
<li>Nulla volutpat aliquam velit
|
|
||||||
<ul>
|
|
||||||
<li>Phasellus iaculis neque</li>
|
|
||||||
<li>Purus sodales ultricies</li>
|
|
||||||
<li>Vestibulum laoreet porttitor sem</li>
|
|
||||||
<li>Ac tristique libero volutpat at</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>Faucibus porta lacus fringilla vel</li>
|
|
||||||
<li>Aenean sit amet erat nunc</li>
|
|
||||||
<li>Eget porttitor lorem</li>
|
|
||||||
</ul>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Ordered
|
|
||||||
|
|
||||||
A list of items in which the order of items does explicitly matter.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
1. Lorem ipsum dolor sit amet
|
|
||||||
2. Consectetur adipiscing elit
|
|
||||||
3. Integer molestie lorem at massa
|
|
||||||
4. Facilisis in pretium nisl aliquet
|
|
||||||
5. Nulla volutpat aliquam velit
|
|
||||||
6. Faucibus porta lacus fringilla vel
|
|
||||||
7. Aenean sit amet erat nunc
|
|
||||||
8. Eget porttitor lorem
|
|
||||||
```
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
1. Lorem ipsum dolor sit amet
|
|
||||||
2. Consectetur adipiscing elit
|
|
||||||
3. Integer molestie lorem at massa
|
|
||||||
4. Facilisis in pretium nisl aliquet
|
|
||||||
5. Nulla volutpat aliquam velit
|
|
||||||
6. Faucibus porta lacus fringilla vel
|
|
||||||
7. Aenean sit amet erat nunc
|
|
||||||
8. Eget porttitor lorem
|
|
||||||
|
|
||||||
And this HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<ol>
|
|
||||||
<li>Lorem ipsum dolor sit amet</li>
|
|
||||||
<li>Consectetur adipiscing elit</li>
|
|
||||||
<li>Integer molestie lorem at massa</li>
|
|
||||||
<li>Facilisis in pretium nisl aliquet</li>
|
|
||||||
<li>Nulla volutpat aliquam velit</li>
|
|
||||||
<li>Faucibus porta lacus fringilla vel</li>
|
|
||||||
<li>Aenean sit amet erat nunc</li>
|
|
||||||
<li>Eget porttitor lorem</li>
|
|
||||||
</ol>
|
|
||||||
```
|
|
||||||
|
|
||||||
**TIP**: If you just use `1.` for each number, Markdown will automatically number each item. For example:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
1. Lorem ipsum dolor sit amet
|
|
||||||
1. Consectetur adipiscing elit
|
|
||||||
1. Integer molestie lorem at massa
|
|
||||||
1. Facilisis in pretium nisl aliquet
|
|
||||||
1. Nulla volutpat aliquam velit
|
|
||||||
1. Faucibus porta lacus fringilla vel
|
|
||||||
1. Aenean sit amet erat nunc
|
|
||||||
1. Eget porttitor lorem
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
1. Lorem ipsum dolor sit amet
|
|
||||||
2. Consectetur adipiscing elit
|
|
||||||
3. Integer molestie lorem at massa
|
|
||||||
4. Facilisis in pretium nisl aliquet
|
|
||||||
5. Nulla volutpat aliquam velit
|
|
||||||
6. Faucibus porta lacus fringilla vel
|
|
||||||
7. Aenean sit amet erat nunc
|
|
||||||
8. Eget porttitor lorem
|
|
||||||
|
|
||||||
## Code
|
|
||||||
|
|
||||||
### Inline code
|
|
||||||
Wrap inline snippets of code with `` ` ``.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
In this example, `<section></section>` should be wrapped as **code**.
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
In this example, `<section></section>` should be wrapped with **code**.
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<p>In this example, <code><section></section></code> should be wrapped with <strong>code</strong>.</p>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Indented code
|
|
||||||
|
|
||||||
Or indent several lines of code by at least four spaces, as in:
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
// Some comments
|
|
||||||
line 1 of code
|
|
||||||
line 2 of code
|
|
||||||
line 3 of code
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
// Some comments
|
|
||||||
line 1 of code
|
|
||||||
line 2 of code
|
|
||||||
line 3 of code
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<pre>
|
|
||||||
<code>
|
|
||||||
// Some comments
|
|
||||||
line 1 of code
|
|
||||||
line 2 of code
|
|
||||||
line 3 of code
|
|
||||||
</code>
|
|
||||||
</pre>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### Block code "fences"
|
|
||||||
|
|
||||||
Use "fences" ```` ``` ```` to block in multiple lines of code.
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
``` markup
|
|
||||||
Sample text here...
|
|
||||||
```
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
Sample text here...
|
|
||||||
```
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<pre>
|
|
||||||
<code>Sample text here...</code>
|
|
||||||
</pre>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Syntax highlighting
|
|
||||||
|
|
||||||
GFM, or "GitHub Flavored Markdown" also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code "fence", ` ```js `, and syntax highlighting will automatically be applied in the rendered HTML. For example, to apply syntax highlighting to JavaScript code:
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
```js
|
|
||||||
grunt.initConfig({
|
|
||||||
assemble: {
|
|
||||||
options: {
|
|
||||||
assets: 'docs/assets',
|
|
||||||
data: 'src/data/*.{json,yml}',
|
|
||||||
helpers: 'src/custom-helpers.js',
|
|
||||||
partials: ['src/partials/**/*.{hbs,md}']
|
|
||||||
},
|
|
||||||
pages: {
|
|
||||||
options: {
|
|
||||||
layout: 'default.hbs'
|
|
||||||
},
|
|
||||||
files: {
|
|
||||||
'./': ['src/templates/pages/index.hbs']
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
|
||||||
```
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
```js
|
|
||||||
grunt.initConfig({
|
|
||||||
assemble: {
|
|
||||||
options: {
|
|
||||||
assets: 'docs/assets',
|
|
||||||
data: 'src/data/*.{json,yml}',
|
|
||||||
helpers: 'src/custom-helpers.js',
|
|
||||||
partials: ['src/partials/**/*.{hbs,md}']
|
|
||||||
},
|
|
||||||
pages: {
|
|
||||||
options: {
|
|
||||||
layout: 'default.hbs'
|
|
||||||
},
|
|
||||||
files: {
|
|
||||||
'./': ['src/templates/pages/index.hbs']
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Tables
|
|
||||||
Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.
|
|
||||||
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
| Option | Description |
|
|
||||||
| ------ | ----------- |
|
|
||||||
| data | path to data files to supply the data that will be passed into templates. |
|
|
||||||
| engine | engine to be used for processing templates. Handlebars is the default. |
|
|
||||||
| ext | extension to be used for dest files. |
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
| Option | Description |
|
|
||||||
| ------ | ----------- |
|
|
||||||
| data | path to data files to supply the data that will be passed into templates. |
|
|
||||||
| engine | engine to be used for processing templates. Handlebars is the default. |
|
|
||||||
| ext | extension to be used for dest files. |
|
|
||||||
|
|
||||||
And this HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th>Option</th>
|
|
||||||
<th>Description</th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>data</td>
|
|
||||||
<td>path to data files to supply the data that will be passed into templates.</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>engine</td>
|
|
||||||
<td>engine to be used for processing templates. Handlebars is the default.</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>ext</td>
|
|
||||||
<td>extension to be used for dest files.</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Right aligned text
|
|
||||||
|
|
||||||
Adding a colon on the right side of the dashes below any heading will right align text for that column.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
| Option | Description |
|
|
||||||
| ------:| -----------:|
|
|
||||||
| data | path to data files to supply the data that will be passed into templates. |
|
|
||||||
| engine | engine to be used for processing templates. Handlebars is the default. |
|
|
||||||
| ext | extension to be used for dest files. |
|
|
||||||
```
|
|
||||||
|
|
||||||
| Option | Description |
|
|
||||||
| ------:| -----------:|
|
|
||||||
| data | path to data files to supply the data that will be passed into templates. |
|
|
||||||
| engine | engine to be used for processing templates. Handlebars is the default. |
|
|
||||||
| ext | extension to be used for dest files. |
|
|
||||||
|
|
||||||
## Links
|
|
||||||
|
|
||||||
### Basic link
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
[Assemble](http://assemble.io)
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to (hover over the link, there is no tooltip):
|
|
||||||
|
|
||||||
[Assemble](http://assemble.io)
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<a href="http://assemble.io">Assemble</a>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### Add a title
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
[Upstage](https://github.com/upstage/ "Visit Upstage!")
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to (hover over the link, there should be a tooltip):
|
|
||||||
|
|
||||||
[Upstage](https://github.com/upstage/ "Visit Upstage!")
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<a href="https://github.com/upstage/" title="Visit Upstage!">Upstage</a>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Named Anchors
|
|
||||||
|
|
||||||
Named anchors enable you to jump to the specified anchor point on the same page. For example, each of these chapters:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
# Table of Contents
|
|
||||||
* [Chapter 1](#chapter-1)
|
|
||||||
* [Chapter 2](#chapter-2)
|
|
||||||
* [Chapter 3](#chapter-3)
|
|
||||||
```
|
|
||||||
will jump to these sections:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
## Chapter 1 <a id="chapter-1"></a>
|
|
||||||
Content for chapter one.
|
|
||||||
|
|
||||||
## Chapter 2 <a id="chapter-2"></a>
|
|
||||||
Content for chapter one.
|
|
||||||
|
|
||||||
## Chapter 3 <a id="chapter-3"></a>
|
|
||||||
Content for chapter one.
|
|
||||||
```
|
|
||||||
**NOTE** that specific placement of the anchor tag seems to be arbitrary. They are placed inline here since it seems to be unobtrusive, and it works.
|
|
||||||
|
|
||||||
## Images {#images}
|
|
||||||
Images have a similar syntax to links but include a preceding exclamation point.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||

|
|
||||||
```
|
|
||||||

|
|
||||||
|
|
||||||
or
|
|
||||||
```markdown
|
|
||||||

|
|
||||||
```
|
|
||||||

|
|
||||||
|
|
||||||
Like links, Images also have a footnote style syntax
|
|
||||||
|
|
||||||
### Alternative usage : note images
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
![Alt text][id]
|
|
||||||
```
|
|
||||||
![Alt text][id]
|
|
||||||
|
|
||||||
With a reference later in the document defining the URL location:
|
|
||||||
|
|
||||||
[id]: http://octodex.github.com/images/dojocat.jpg "The Dojocat"
|
|
||||||
|
|
||||||
[id]: http://octodex.github.com/images/dojocat.jpg "The Dojocat"
|
|
||||||
|
|
||||||
### Resizing image
|
|
||||||
|
|
||||||
Add HTTP parameters `width` and/or `height` to the link image to resize the image. Values are CSS values (default is `auto`).
|
|
||||||
|
|
||||||
```markdown
|
|
||||||

|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
```markdown
|
|
||||||

|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
```markdown
|
|
||||||

|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
### Add CSS classes
|
|
||||||
|
|
||||||
Add a HTTP `classes` parameter to the link image to add CSS classes. `shadow`and `border` are available but you could define other ones.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||

|
|
||||||
```
|
|
||||||

|
|
||||||
|
|
||||||
```markdown
|
|
||||||

|
|
||||||
```
|
|
||||||

|
|
||||||
|
|
||||||
```markdown
|
|
||||||

|
|
||||||
```
|
|
||||||

|
|
||||||
@@ -1,665 +0,0 @@
|
|||||||
---
|
|
||||||
date: 2016-04-09T16:50:16+02:00
|
|
||||||
title: Syntaxe Markdown
|
|
||||||
weight: 15
|
|
||||||
---
|
|
||||||
|
|
||||||
{{% notice note %}}
|
|
||||||
Cette page est une copie de la [doc de Grav](http://learn.getgrav.org/content/markdown).
|
|
||||||
La seule différence porte sur la personalisation des images ([taille]({{< relref "#resizing-image" >}}), [ajout de classes CSS]({{< relref "#add-css-classes" >}})...)
|
|
||||||
Pour des raisons évidentes, cette page n'a pas été traduites en français 😁
|
|
||||||
{{% /notice%}}
|
|
||||||
|
|
||||||
Let's face it: Writing content for the Web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.
|
|
||||||
|
|
||||||
**Markdown** is a better way to write **HTML**, without all the complexities and ugliness that usually accompanies it.
|
|
||||||
|
|
||||||
Some of the key benefits are:
|
|
||||||
|
|
||||||
1. Markdown is simple to learn, with minimal extra characters so it's also quicker to write content.
|
|
||||||
2. Less chance of errors when writing in markdown.
|
|
||||||
3. Produces valid XHTML output.
|
|
||||||
4. Keeps the content and the visual display separate, so you cannot mess up the look of your site.
|
|
||||||
5. Write in any text editor or Markdown application you like.
|
|
||||||
6. Markdown is a joy to use!
|
|
||||||
|
|
||||||
John Gruber, the author of Markdown, puts it like this:
|
|
||||||
|
|
||||||
> The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
|
|
||||||
> -- <cite>John Gruber</cite>
|
|
||||||
|
|
||||||
|
|
||||||
Grav ships with built-in support for [Markdown](http://daringfireball.net/projects/markdown/) and [Markdown Extra](https://michelf.ca/projects/php-markdown/extra/). You must enable **Markdown Extra** in your `system.yaml` configuration file
|
|
||||||
|
|
||||||
Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:
|
|
||||||
|
|
||||||
{{% notice info %}}
|
|
||||||
<i class="fa fa-bookmark"></i> Bookmark this page for easy future reference!
|
|
||||||
{{% /notice %}}
|
|
||||||
|
|
||||||
## Headings
|
|
||||||
|
|
||||||
Headings from `h1` through `h6` are constructed with a `#` for each level:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
# h1 Heading
|
|
||||||
## h2 Heading
|
|
||||||
### h3 Heading
|
|
||||||
#### h4 Heading
|
|
||||||
##### h5 Heading
|
|
||||||
###### h6 Heading
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
# h1 Heading
|
|
||||||
## h2 Heading
|
|
||||||
### h3 Heading
|
|
||||||
#### h4 Heading
|
|
||||||
##### h5 Heading
|
|
||||||
###### h6 Heading
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<h1>h1 Heading</h1>
|
|
||||||
<h2>h2 Heading</h2>
|
|
||||||
<h3>h3 Heading</h3>
|
|
||||||
<h4>h4 Heading</h4>
|
|
||||||
<h5>h5 Heading</h5>
|
|
||||||
<h6>h6 Heading</h6>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Comments
|
|
||||||
|
|
||||||
Comments should be HTML compatible
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!--
|
|
||||||
This is a comment
|
|
||||||
-->
|
|
||||||
```
|
|
||||||
Comment below should **NOT** be seen:
|
|
||||||
|
|
||||||
<!--
|
|
||||||
This is a comment
|
|
||||||
-->
|
|
||||||
|
|
||||||
|
|
||||||
## Horizontal Rules
|
|
||||||
|
|
||||||
The HTML `<hr>` element is for creating a "thematic break" between paragraph-level elements. In markdown, you can create a `<hr>` with any of the following:
|
|
||||||
|
|
||||||
* `___`: three consecutive underscores
|
|
||||||
* `---`: three consecutive dashes
|
|
||||||
* `***`: three consecutive asterisks
|
|
||||||
|
|
||||||
renders to:
|
|
||||||
|
|
||||||
___
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
|
|
||||||
## Body Copy
|
|
||||||
|
|
||||||
Body copy written as normal, plain text will be wrapped with `<p></p>` tags in the rendered HTML.
|
|
||||||
|
|
||||||
So this body copy:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
|
|
||||||
```
|
|
||||||
renders to this HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</p>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Emphasis
|
|
||||||
|
|
||||||
### Bold
|
|
||||||
For emphasizing a snippet of text with a heavier font-weight.
|
|
||||||
|
|
||||||
The following snippet of text is **rendered as bold text**.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
**rendered as bold text**
|
|
||||||
```
|
|
||||||
renders to:
|
|
||||||
|
|
||||||
**rendered as bold text**
|
|
||||||
|
|
||||||
and this HTML
|
|
||||||
|
|
||||||
```html
|
|
||||||
<strong>rendered as bold text</strong>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Italics
|
|
||||||
For emphasizing a snippet of text with italics.
|
|
||||||
|
|
||||||
The following snippet of text is _rendered as italicized text_.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
_rendered as italicized text_
|
|
||||||
```
|
|
||||||
|
|
||||||
renders to:
|
|
||||||
|
|
||||||
_rendered as italicized text_
|
|
||||||
|
|
||||||
and this HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<em>rendered as italicized text</em>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### strikethrough
|
|
||||||
In GFM (GitHub flavored Markdown) you can do strikethroughs.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
~~Strike through this text.~~
|
|
||||||
```
|
|
||||||
Which renders to:
|
|
||||||
|
|
||||||
~~Strike through this text.~~
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<del>Strike through this text.</del>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Blockquotes
|
|
||||||
For quoting blocks of content from another source within your document.
|
|
||||||
|
|
||||||
Add `>` before any text you want to quote.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
> **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
> **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
|
|
||||||
|
|
||||||
and this HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<blockquote>
|
|
||||||
<p><strong>Fusion Drive</strong> combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.</p>
|
|
||||||
</blockquote>
|
|
||||||
```
|
|
||||||
|
|
||||||
Blockquotes can also be nested:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
|
|
||||||
Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
|
|
||||||
>> Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor
|
|
||||||
odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
|
|
||||||
Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
|
|
||||||
>> Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor
|
|
||||||
odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
|
|
||||||
|
|
||||||
|
|
||||||
## Notices
|
|
||||||
|
|
||||||
{{% notice note %}}
|
|
||||||
The old mechanism for notices overriding the block quote syntax (`>>>`) has been deprecated. Notices are now handled via a dedicated plugin called [Markdown Notices](https://github.com/getgrav/grav-plugin-markdown-notices)
|
|
||||||
{{% /notice %}}
|
|
||||||
|
|
||||||
|
|
||||||
## Lists
|
|
||||||
|
|
||||||
### Unordered
|
|
||||||
A list of items in which the order of the items does not explicitly matter.
|
|
||||||
|
|
||||||
You may use any of the following symbols to denote bullets for each list item:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
* valid bullet
|
|
||||||
- valid bullet
|
|
||||||
+ valid bullet
|
|
||||||
```
|
|
||||||
|
|
||||||
For example
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
+ Lorem ipsum dolor sit amet
|
|
||||||
+ Consectetur adipiscing elit
|
|
||||||
+ Integer molestie lorem at massa
|
|
||||||
+ Facilisis in pretium nisl aliquet
|
|
||||||
+ Nulla volutpat aliquam velit
|
|
||||||
- Phasellus iaculis neque
|
|
||||||
- Purus sodales ultricies
|
|
||||||
- Vestibulum laoreet porttitor sem
|
|
||||||
- Ac tristique libero volutpat at
|
|
||||||
+ Faucibus porta lacus fringilla vel
|
|
||||||
+ Aenean sit amet erat nunc
|
|
||||||
+ Eget porttitor lorem
|
|
||||||
```
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
+ Lorem ipsum dolor sit amet
|
|
||||||
+ Consectetur adipiscing elit
|
|
||||||
+ Integer molestie lorem at massa
|
|
||||||
+ Facilisis in pretium nisl aliquet
|
|
||||||
+ Nulla volutpat aliquam velit
|
|
||||||
- Phasellus iaculis neque
|
|
||||||
- Purus sodales ultricies
|
|
||||||
- Vestibulum laoreet porttitor sem
|
|
||||||
- Ac tristique libero volutpat at
|
|
||||||
+ Faucibus porta lacus fringilla vel
|
|
||||||
+ Aenean sit amet erat nunc
|
|
||||||
+ Eget porttitor lorem
|
|
||||||
|
|
||||||
And this HTML
|
|
||||||
|
|
||||||
```html
|
|
||||||
<ul>
|
|
||||||
<li>Lorem ipsum dolor sit amet</li>
|
|
||||||
<li>Consectetur adipiscing elit</li>
|
|
||||||
<li>Integer molestie lorem at massa</li>
|
|
||||||
<li>Facilisis in pretium nisl aliquet</li>
|
|
||||||
<li>Nulla volutpat aliquam velit
|
|
||||||
<ul>
|
|
||||||
<li>Phasellus iaculis neque</li>
|
|
||||||
<li>Purus sodales ultricies</li>
|
|
||||||
<li>Vestibulum laoreet porttitor sem</li>
|
|
||||||
<li>Ac tristique libero volutpat at</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>Faucibus porta lacus fringilla vel</li>
|
|
||||||
<li>Aenean sit amet erat nunc</li>
|
|
||||||
<li>Eget porttitor lorem</li>
|
|
||||||
</ul>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Ordered
|
|
||||||
|
|
||||||
A list of items in which the order of items does explicitly matter.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
1. Lorem ipsum dolor sit amet
|
|
||||||
2. Consectetur adipiscing elit
|
|
||||||
3. Integer molestie lorem at massa
|
|
||||||
4. Facilisis in pretium nisl aliquet
|
|
||||||
5. Nulla volutpat aliquam velit
|
|
||||||
6. Faucibus porta lacus fringilla vel
|
|
||||||
7. Aenean sit amet erat nunc
|
|
||||||
8. Eget porttitor lorem
|
|
||||||
```
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
1. Lorem ipsum dolor sit amet
|
|
||||||
2. Consectetur adipiscing elit
|
|
||||||
3. Integer molestie lorem at massa
|
|
||||||
4. Facilisis in pretium nisl aliquet
|
|
||||||
5. Nulla volutpat aliquam velit
|
|
||||||
6. Faucibus porta lacus fringilla vel
|
|
||||||
7. Aenean sit amet erat nunc
|
|
||||||
8. Eget porttitor lorem
|
|
||||||
|
|
||||||
And this HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<ol>
|
|
||||||
<li>Lorem ipsum dolor sit amet</li>
|
|
||||||
<li>Consectetur adipiscing elit</li>
|
|
||||||
<li>Integer molestie lorem at massa</li>
|
|
||||||
<li>Facilisis in pretium nisl aliquet</li>
|
|
||||||
<li>Nulla volutpat aliquam velit</li>
|
|
||||||
<li>Faucibus porta lacus fringilla vel</li>
|
|
||||||
<li>Aenean sit amet erat nunc</li>
|
|
||||||
<li>Eget porttitor lorem</li>
|
|
||||||
</ol>
|
|
||||||
```
|
|
||||||
|
|
||||||
**TIP**: If you just use `1.` for each number, Markdown will automatically number each item. For example:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
1. Lorem ipsum dolor sit amet
|
|
||||||
1. Consectetur adipiscing elit
|
|
||||||
1. Integer molestie lorem at massa
|
|
||||||
1. Facilisis in pretium nisl aliquet
|
|
||||||
1. Nulla volutpat aliquam velit
|
|
||||||
1. Faucibus porta lacus fringilla vel
|
|
||||||
1. Aenean sit amet erat nunc
|
|
||||||
1. Eget porttitor lorem
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
1. Lorem ipsum dolor sit amet
|
|
||||||
2. Consectetur adipiscing elit
|
|
||||||
3. Integer molestie lorem at massa
|
|
||||||
4. Facilisis in pretium nisl aliquet
|
|
||||||
5. Nulla volutpat aliquam velit
|
|
||||||
6. Faucibus porta lacus fringilla vel
|
|
||||||
7. Aenean sit amet erat nunc
|
|
||||||
8. Eget porttitor lorem
|
|
||||||
|
|
||||||
## Code
|
|
||||||
|
|
||||||
### Inline code
|
|
||||||
Wrap inline snippets of code with `` ` ``.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
In this example, `<section></section>` should be wrapped as **code**.
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
In this example, `<section></section>` should be wrapped with **code**.
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<p>In this example, <code><section></section></code> should be wrapped with <strong>code</strong>.</p>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Indented code
|
|
||||||
|
|
||||||
Or indent several lines of code by at least four spaces, as in:
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
// Some comments
|
|
||||||
line 1 of code
|
|
||||||
line 2 of code
|
|
||||||
line 3 of code
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
// Some comments
|
|
||||||
line 1 of code
|
|
||||||
line 2 of code
|
|
||||||
line 3 of code
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<pre>
|
|
||||||
<code>
|
|
||||||
// Some comments
|
|
||||||
line 1 of code
|
|
||||||
line 2 of code
|
|
||||||
line 3 of code
|
|
||||||
</code>
|
|
||||||
</pre>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### Block code "fences"
|
|
||||||
|
|
||||||
Use "fences" ```` ``` ```` to block in multiple lines of code.
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
``` markup
|
|
||||||
Sample text here...
|
|
||||||
```
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
Sample text here...
|
|
||||||
```
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<pre>
|
|
||||||
<code>Sample text here...</code>
|
|
||||||
</pre>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Syntax highlighting
|
|
||||||
|
|
||||||
GFM, or "GitHub Flavored Markdown" also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code "fence", ` ```js `, and syntax highlighting will automatically be applied in the rendered HTML. For example, to apply syntax highlighting to JavaScript code:
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
```js
|
|
||||||
grunt.initConfig({
|
|
||||||
assemble: {
|
|
||||||
options: {
|
|
||||||
assets: 'docs/assets',
|
|
||||||
data: 'src/data/*.{json,yml}',
|
|
||||||
helpers: 'src/custom-helpers.js',
|
|
||||||
partials: ['src/partials/**/*.{hbs,md}']
|
|
||||||
},
|
|
||||||
pages: {
|
|
||||||
options: {
|
|
||||||
layout: 'default.hbs'
|
|
||||||
},
|
|
||||||
files: {
|
|
||||||
'./': ['src/templates/pages/index.hbs']
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
|
||||||
```
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
```js
|
|
||||||
grunt.initConfig({
|
|
||||||
assemble: {
|
|
||||||
options: {
|
|
||||||
assets: 'docs/assets',
|
|
||||||
data: 'src/data/*.{json,yml}',
|
|
||||||
helpers: 'src/custom-helpers.js',
|
|
||||||
partials: ['src/partials/**/*.{hbs,md}']
|
|
||||||
},
|
|
||||||
pages: {
|
|
||||||
options: {
|
|
||||||
layout: 'default.hbs'
|
|
||||||
},
|
|
||||||
files: {
|
|
||||||
'./': ['src/templates/pages/index.hbs']
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Tables
|
|
||||||
Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.
|
|
||||||
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
| Option | Description |
|
|
||||||
| ------ | ----------- |
|
|
||||||
| data | path to data files to supply the data that will be passed into templates. |
|
|
||||||
| engine | engine to be used for processing templates. Handlebars is the default. |
|
|
||||||
| ext | extension to be used for dest files. |
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
| Option | Description |
|
|
||||||
| ------ | ----------- |
|
|
||||||
| data | path to data files to supply the data that will be passed into templates. |
|
|
||||||
| engine | engine to be used for processing templates. Handlebars is the default. |
|
|
||||||
| ext | extension to be used for dest files. |
|
|
||||||
|
|
||||||
And this HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th>Option</th>
|
|
||||||
<th>Description</th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>data</td>
|
|
||||||
<td>path to data files to supply the data that will be passed into templates.</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>engine</td>
|
|
||||||
<td>engine to be used for processing templates. Handlebars is the default.</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>ext</td>
|
|
||||||
<td>extension to be used for dest files.</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Right aligned text
|
|
||||||
|
|
||||||
Adding a colon on the right side of the dashes below any heading will right align text for that column.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
| Option | Description |
|
|
||||||
| ------:| -----------:|
|
|
||||||
| data | path to data files to supply the data that will be passed into templates. |
|
|
||||||
| engine | engine to be used for processing templates. Handlebars is the default. |
|
|
||||||
| ext | extension to be used for dest files. |
|
|
||||||
```
|
|
||||||
|
|
||||||
| Option | Description |
|
|
||||||
| ------:| -----------:|
|
|
||||||
| data | path to data files to supply the data that will be passed into templates. |
|
|
||||||
| engine | engine to be used for processing templates. Handlebars is the default. |
|
|
||||||
| ext | extension to be used for dest files. |
|
|
||||||
|
|
||||||
## Links
|
|
||||||
|
|
||||||
### Basic link
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
[Assemble](http://assemble.io)
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to (hover over the link, there is no tooltip):
|
|
||||||
|
|
||||||
[Assemble](http://assemble.io)
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<a href="http://assemble.io">Assemble</a>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### Add a title
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
[Upstage](https://github.com/upstage/ "Visit Upstage!")
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to (hover over the link, there should be a tooltip):
|
|
||||||
|
|
||||||
[Upstage](https://github.com/upstage/ "Visit Upstage!")
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<a href="https://github.com/upstage/" title="Visit Upstage!">Upstage</a>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Named Anchors
|
|
||||||
|
|
||||||
Named anchors enable you to jump to the specified anchor point on the same page. For example, each of these chapters:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
# Table of Contents
|
|
||||||
* [Chapter 1](#chapter-1)
|
|
||||||
* [Chapter 2](#chapter-2)
|
|
||||||
* [Chapter 3](#chapter-3)
|
|
||||||
```
|
|
||||||
will jump to these sections:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
## Chapter 1 <a id="chapter-1"></a>
|
|
||||||
Content for chapter one.
|
|
||||||
|
|
||||||
## Chapter 2 <a id="chapter-2"></a>
|
|
||||||
Content for chapter one.
|
|
||||||
|
|
||||||
## Chapter 3 <a id="chapter-3"></a>
|
|
||||||
Content for chapter one.
|
|
||||||
```
|
|
||||||
**NOTE** that specific placement of the anchor tag seems to be arbitrary. They are placed inline here since it seems to be unobtrusive, and it works.
|
|
||||||
|
|
||||||
|
|
||||||
## Images {#images}
|
|
||||||
Images have a similar syntax to links but include a preceding exclamation point.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||

|
|
||||||
```
|
|
||||||

|
|
||||||
|
|
||||||
or
|
|
||||||
```markdown
|
|
||||||

|
|
||||||
```
|
|
||||||

|
|
||||||
|
|
||||||
Like links, Images also have a footnote style syntax
|
|
||||||
|
|
||||||
### Alternative usage : note images
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
![Alt text][id]
|
|
||||||
```
|
|
||||||
![Alt text][id]
|
|
||||||
|
|
||||||
With a reference later in the document defining the URL location:
|
|
||||||
|
|
||||||
[id]: http://octodex.github.com/images/dojocat.jpg "The Dojocat"
|
|
||||||
|
|
||||||
[id]: http://octodex.github.com/images/dojocat.jpg "The Dojocat"
|
|
||||||
|
|
||||||
### Resizing image
|
|
||||||
|
|
||||||
Add HTTP parameters `width` and/or `height` to the link image to resize the image. Values are CSS values (default is `auto`).
|
|
||||||
|
|
||||||
```markdown
|
|
||||||

|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
```markdown
|
|
||||||

|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
```markdown
|
|
||||||

|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
### Add CSS classes
|
|
||||||
|
|
||||||
Add a HTTP `classes` parameter to the link image to add CSS classes. `shadow`and `border` are available but you could define other ones.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||

|
|
||||||
```
|
|
||||||

|
|
||||||
|
|
||||||
```markdown
|
|
||||||

|
|
||||||
```
|
|
||||||

|
|
||||||
|
|
||||||
```markdown
|
|
||||||

|
|
||||||
```
|
|
||||||

|
|
||||||
@@ -1,109 +0,0 @@
|
|||||||
---
|
|
||||||
date: 2016-04-09T16:50:16+02:00
|
|
||||||
title: Menu extra shortcuts
|
|
||||||
weight: 25
|
|
||||||
---
|
|
||||||
|
|
||||||
You can define additional menu entries or shortcuts in the navigation menu without any link to content.
|
|
||||||
|
|
||||||
## Basic configuration
|
|
||||||
|
|
||||||
Edit the website configuration `config.toml` and add a `[[menu.shortcuts]]` entry for each link your want to add.
|
|
||||||
|
|
||||||
Example from the current website:
|
|
||||||
|
|
||||||
[[menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-github'></i> Github repo"
|
|
||||||
identifier = "ds"
|
|
||||||
url = "https://github.com/matcornic/hugo-theme-learn"
|
|
||||||
weight = 10
|
|
||||||
|
|
||||||
[[menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-camera'></i> Showcases"
|
|
||||||
url = "/showcase"
|
|
||||||
weight = 11
|
|
||||||
|
|
||||||
[[menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-bookmark'></i> Hugo Documentation"
|
|
||||||
identifier = "hugodoc"
|
|
||||||
url = "https://gohugo.io/"
|
|
||||||
weight = 20
|
|
||||||
|
|
||||||
[[menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-bullhorn'></i> Credits"
|
|
||||||
url = "/credits"
|
|
||||||
weight = 30
|
|
||||||
|
|
||||||
By default, shortcuts are preceded by a title. This title can be disabled by setting `disableShortcutsTitle=true`.
|
|
||||||
However, if you want to keep the title but change its value, it can be overriden by changing your local i18n translation string configuration.
|
|
||||||
|
|
||||||
For example, in your local `i18n/en.toml` file, add the following content
|
|
||||||
|
|
||||||
[Shortcuts-Title]
|
|
||||||
other = "<Your value>"
|
|
||||||
|
|
||||||
Read more about [hugo menu](https://gohugo.io/extras/menus/) and [hugo i18n translation strings](https://gohugo.io/content-management/multilingual/#translation-of-strings)
|
|
||||||
|
|
||||||
## Configuration for Multilingual mode {#i18n}
|
|
||||||
|
|
||||||
When using a multilingual website, you can set different menus for each language. In the `config.toml` file, prefix your menu configuration by `Languages.<language-id>`.
|
|
||||||
|
|
||||||
|
|
||||||
Example from the current website:
|
|
||||||
|
|
||||||
[Languages]
|
|
||||||
[Languages.en]
|
|
||||||
title = "Documentation for Hugo Learn Theme"
|
|
||||||
weight = 1
|
|
||||||
languageName = "English"
|
|
||||||
|
|
||||||
[[Languages.en.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-github'></i> Github repo"
|
|
||||||
identifier = "ds"
|
|
||||||
url = "https://github.com/matcornic/hugo-theme-learn"
|
|
||||||
weight = 10
|
|
||||||
|
|
||||||
[[Languages.en.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-camera'></i> Showcases"
|
|
||||||
url = "/showcase"
|
|
||||||
weight = 11
|
|
||||||
|
|
||||||
[[Languages.en.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-bookmark'></i> Hugo Documentation"
|
|
||||||
identifier = "hugodoc"
|
|
||||||
url = "https://gohugo.io/"
|
|
||||||
weight = 20
|
|
||||||
|
|
||||||
[[Languages.en.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-bullhorn'></i> Credits"
|
|
||||||
url = "/credits"
|
|
||||||
weight = 30
|
|
||||||
|
|
||||||
[Languages.fr]
|
|
||||||
title = "Documentation du thème Hugo Learn"
|
|
||||||
weight = 2
|
|
||||||
languageName = "Français"
|
|
||||||
|
|
||||||
[[Languages.fr.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-github'></i> Repo Github"
|
|
||||||
identifier = "ds"
|
|
||||||
url = "https://github.com/matcornic/hugo-theme-learn"
|
|
||||||
weight = 10
|
|
||||||
|
|
||||||
[[Languages.fr.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-camera'></i> Vitrine"
|
|
||||||
url = "/showcase"
|
|
||||||
weight = 11
|
|
||||||
|
|
||||||
[[Languages.fr.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-bookmark'></i> Documentation Hugo"
|
|
||||||
identifier = "hugodoc"
|
|
||||||
url = "https://gohugo.io/"
|
|
||||||
weight = 20
|
|
||||||
|
|
||||||
[[Languages.fr.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-bullhorn'></i> Crédits"
|
|
||||||
url = "/credits"
|
|
||||||
weight = 30
|
|
||||||
|
|
||||||
Read more about [hugo menu](https://gohugo.io/extras/menus/) and [hugo multilingual menus](https://gohugo.io/content-management/multilingual/#menus)
|
|
||||||
@@ -1,109 +0,0 @@
|
|||||||
---
|
|
||||||
date: 2016-04-09T16:50:16+02:00
|
|
||||||
title: Raccourcis du menu
|
|
||||||
weight: 25
|
|
||||||
---
|
|
||||||
|
|
||||||
Vous pouvez définir des entrées ou raccourcis supplémentaires dans le menu sans avoir besoin d'être lié à un contenu du site.
|
|
||||||
|
|
||||||
## Configuration simple
|
|
||||||
|
|
||||||
Editez le fichier de configuration `config.toml` et ajoutez une entrée `[[menu.shortcuts]]` pour chaque lien que vous voulez ajouter.
|
|
||||||
|
|
||||||
Exemple pour ce site:
|
|
||||||
|
|
||||||
[[menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-github'></i> Github repo"
|
|
||||||
identifier = "ds"
|
|
||||||
url = "https://github.com/matcornic/hugo-theme-learn"
|
|
||||||
weight = 10
|
|
||||||
|
|
||||||
[[menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-camera'></i> Showcases"
|
|
||||||
url = "/showcase"
|
|
||||||
weight = 11
|
|
||||||
|
|
||||||
[[menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-bookmark'></i> Hugo Documentation"
|
|
||||||
identifier = "hugodoc"
|
|
||||||
url = "https://gohugo.io/"
|
|
||||||
weight = 20
|
|
||||||
|
|
||||||
[[menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-bullhorn'></i> Credits"
|
|
||||||
url = "/credits"
|
|
||||||
weight = 30
|
|
||||||
|
|
||||||
Par défaut, les raccourcis sont précédés par un titre. Ce titre peut être désactivé en ajouter le paramètre `disableShortcutsTitle=true` dans la section `params` de votre `config.toml`.
|
|
||||||
Cependant, si vous voulez garder le titre mais changer sa valeur, vous pouvez modifier votre configuration multilangue locale en changeant les *translation string*.
|
|
||||||
|
|
||||||
Par exemple, dans votre fichier local `i18n/en.toml`, ajouter le contenu
|
|
||||||
|
|
||||||
[Shortcuts-Title]
|
|
||||||
other = "<Votre valeur>"
|
|
||||||
|
|
||||||
Plus d'infos sur [les menus Hugo](https://gohugo.io/extras/menus/) et sur [les translations strings](https://gohugo.io/content-management/multilingual/#translation-of-strings)
|
|
||||||
|
|
||||||
## Configuration pour le mode multi-langue {#i18n}
|
|
||||||
|
|
||||||
Quand vous utilisez un site multi-langue, vous pouvez avoir des menus différents pour chaque langage. Dans le fichier de configuration `config.toml`, préfixez votre configuration par `Languages.<language-id>`.
|
|
||||||
|
|
||||||
|
|
||||||
Par exemple, avec ce site :
|
|
||||||
|
|
||||||
[Languages]
|
|
||||||
[Languages.en]
|
|
||||||
title = "Documentation for Hugo Learn Theme"
|
|
||||||
weight = 1
|
|
||||||
languageName = "English"
|
|
||||||
|
|
||||||
[[Languages.en.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-github'></i> Github repo"
|
|
||||||
identifier = "ds"
|
|
||||||
url = "https://github.com/matcornic/hugo-theme-learn"
|
|
||||||
weight = 10
|
|
||||||
|
|
||||||
[[Languages.en.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-camera'></i> Showcases"
|
|
||||||
url = "/showcase"
|
|
||||||
weight = 11
|
|
||||||
|
|
||||||
[[Languages.en.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-bookmark'></i> Hugo Documentation"
|
|
||||||
identifier = "hugodoc"
|
|
||||||
url = "https://gohugo.io/"
|
|
||||||
weight = 20
|
|
||||||
|
|
||||||
[[Languages.en.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-bullhorn'></i> Credits"
|
|
||||||
url = "/credits"
|
|
||||||
weight = 30
|
|
||||||
|
|
||||||
[Languages.fr]
|
|
||||||
title = "Documentation du thème Hugo Learn"
|
|
||||||
weight = 2
|
|
||||||
languageName = "Français"
|
|
||||||
|
|
||||||
[[Languages.fr.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-github'></i> Repo Github"
|
|
||||||
identifier = "ds"
|
|
||||||
url = "https://github.com/matcornic/hugo-theme-learn"
|
|
||||||
weight = 10
|
|
||||||
|
|
||||||
[[Languages.fr.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-camera'></i> Vitrine"
|
|
||||||
url = "/showcase"
|
|
||||||
weight = 11
|
|
||||||
|
|
||||||
[[Languages.fr.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-bookmark'></i> Documentation Hugo"
|
|
||||||
identifier = "hugodoc"
|
|
||||||
url = "https://gohugo.io/"
|
|
||||||
weight = 20
|
|
||||||
|
|
||||||
[[Languages.fr.menu.shortcuts]]
|
|
||||||
name = "<i class='fa fa-bullhorn'></i> Crédits"
|
|
||||||
url = "/credits"
|
|
||||||
weight = 30
|
|
||||||
|
|
||||||
Plus d'infos sur [les menus Hugo](https://gohugo.io/extras/menus/) et les [menus multi-langue Hugo](https://gohugo.io/content-management/multilingual/#menus)
|
|
||||||
@@ -1,166 +0,0 @@
|
|||||||
---
|
|
||||||
date: 2016-04-09T16:50:16+02:00
|
|
||||||
title: Pages organization
|
|
||||||
weight: 5
|
|
||||||
---
|
|
||||||
|
|
||||||
In **Hugo**, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site.
|
|
||||||
|
|
||||||
## Folders
|
|
||||||
|
|
||||||
Organize your site like [any other Hugo project](https://gohugo.io/content/organization/). Typically, you will have a *content* folder with all your pages.
|
|
||||||
|
|
||||||
content
|
|
||||||
├── level-one
|
|
||||||
│ ├── level-two
|
|
||||||
│ │ ├── level-three
|
|
||||||
│ │ │ ├── level-four
|
|
||||||
│ │ │ │ ├── _index.md <-- /level-one/level-two/level-three/level-four
|
|
||||||
│ │ │ │ ├── page-4-a.md <-- /level-one/level-two/level-three/level-four/page-4-a
|
|
||||||
│ │ │ │ ├── page-4-b.md <-- /level-one/level-two/level-three/level-four/page-4-b
|
|
||||||
│ │ │ │ └── page-4-c.md <-- /level-one/level-two/level-three/level-four/page-4-c
|
|
||||||
│ │ │ ├── _index.md <-- /level-one/level-two/level-three
|
|
||||||
│ │ │ ├── page-3-a.md <-- /level-one/level-two/level-three/page-3-a
|
|
||||||
│ │ │ ├── page-3-b.md <-- /level-one/level-two/level-three/page-3-b
|
|
||||||
│ │ │ └── page-3-c.md <-- /level-one/level-two/level-three/page-3-c
|
|
||||||
│ │ ├── _index.md <-- /level-one/level-two
|
|
||||||
│ │ ├── page-2-a.md <-- /level-one/level-two/page-2-a
|
|
||||||
│ │ ├── page-2-b.md <-- /level-one/level-two/page-2-b
|
|
||||||
│ │ └── page-2-c.md <-- /level-one/level-two/page-2-c
|
|
||||||
│ ├── _index.md <-- /level-one
|
|
||||||
│ ├── page-1-a.md <-- /level-one/page-1-a
|
|
||||||
│ ├── page-1-b.md <-- /level-one/page-1-b
|
|
||||||
│ └── page-1-c.md <-- /level-one/page-1-c
|
|
||||||
├── _index.md <-- /
|
|
||||||
└── page-top.md <-- /page-top
|
|
||||||
|
|
||||||
{{% notice note %}}
|
|
||||||
`_index.md` is required in each folder, it’s your “folder home page”
|
|
||||||
{{% /notice %}}
|
|
||||||
|
|
||||||
## Types
|
|
||||||
|
|
||||||
**Hugo-theme-learn** defines two types of pages. *Default* and *Chapter*. Both can be used at any level of the documentation, the only difference being layout display.
|
|
||||||
|
|
||||||
A **Chapter** displays a page meant to be used as introduction for a set of child pages. Commonly, it contains a simple title and a catch line to define content that can be found under it.
|
|
||||||
You can define any HTML as prefix for the menu. In the example below, it's just a number but that could be an [icon](https://fortawesome.github.io/Font-Awesome/).
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
```markdown
|
|
||||||
+++
|
|
||||||
title = "Basics"
|
|
||||||
chapter = true
|
|
||||||
weight = 5
|
|
||||||
pre = "<b>1. </b>"
|
|
||||||
+++
|
|
||||||
|
|
||||||
### Chapter 1
|
|
||||||
|
|
||||||
# Basics
|
|
||||||
|
|
||||||
Discover what this Hugo theme is all about and the core-concepts behind it.
|
|
||||||
```
|
|
||||||
|
|
||||||
To tell **Hugo-theme-learn** to consider a page as a chapter, set `chapter=true` in the Front Matter of the page.
|
|
||||||
|
|
||||||
A **Default** page is any other content page.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
```toml
|
|
||||||
+++
|
|
||||||
title = "Installation"
|
|
||||||
weight = 15
|
|
||||||
+++
|
|
||||||
```
|
|
||||||
|
|
||||||
The following steps are here to help you initialize your new website. If you don't know Hugo at all, we strongly suggest you to train by following this [great documentation for beginners](https://gohugo.io/overview/quickstart/).
|
|
||||||
|
|
||||||
## Create your project
|
|
||||||
|
|
||||||
Hugo provides a `new` command to create a new website.
|
|
||||||
|
|
||||||
```
|
|
||||||
hugo new site <new_project>
|
|
||||||
```
|
|
||||||
|
|
||||||
**Hugo-theme-learn** provides [archetypes]({{< relref "cont/archetypes.fr.md" >}}) to help you create this kind of pages.
|
|
||||||
|
|
||||||
## Front Matter configuration
|
|
||||||
|
|
||||||
Each Hugo page has to define a [Front Matter](https://gohugo.io/content/front-matter/) in *yaml*, *toml* or *json*.
|
|
||||||
|
|
||||||
**Hugo-theme-learn** uses the following parameters on top of Hugo ones :
|
|
||||||
|
|
||||||
```toml
|
|
||||||
+++
|
|
||||||
# Table of content (toc) is enabled by default. Set this parameter to true to disable it.
|
|
||||||
# Note: Toc is always disabled for chapter pages
|
|
||||||
disableToc = "false"
|
|
||||||
# If set, this will be used for the page's menu entry (instead of the `title` attribute)
|
|
||||||
menuTitle = ""
|
|
||||||
# The title of the page in menu will be prefixed by this HTML content
|
|
||||||
pre = ""
|
|
||||||
# The title of the page in menu will be postfixed by this HTML content
|
|
||||||
post = ""
|
|
||||||
# Set the page as a chapter, changing the way it's displayed
|
|
||||||
chapter = false
|
|
||||||
# Hide a menu entry by setting this to true
|
|
||||||
hidden = false
|
|
||||||
# Display name of this page modifier. If set, it will be displayed in the footer.
|
|
||||||
LastModifierDisplayName = ""
|
|
||||||
# Email of this page modifier. If set with LastModifierDisplayName, it will be displayed in the footer
|
|
||||||
LastModifierEmail = ""
|
|
||||||
+++
|
|
||||||
```
|
|
||||||
|
|
||||||
### Add icon to a menu entry
|
|
||||||
|
|
||||||
In the page frontmatter, add a `pre` param to insert any HTML code before the menu label. The example below uses the Github icon.
|
|
||||||
|
|
||||||
```toml
|
|
||||||
+++
|
|
||||||
title = "Github repo"
|
|
||||||
pre = "<i class='fa fa-github'></i> "
|
|
||||||
+++
|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
### Ordering sibling menu/page entries
|
|
||||||
|
|
||||||
Hugo provides a [flexible way](https://gohugo.io/content/ordering/) to handle order for your pages.
|
|
||||||
|
|
||||||
The simplest way is to set `weight` parameter to a number.
|
|
||||||
|
|
||||||
```toml
|
|
||||||
+++
|
|
||||||
title = "My page"
|
|
||||||
weight = 5
|
|
||||||
+++
|
|
||||||
```
|
|
||||||
|
|
||||||
### Using a custom title for menu entries
|
|
||||||
|
|
||||||
By default, **Hugo-theme-learn** will use a page's `title` attribute for the menu item (or `linkTitle` if defined).
|
|
||||||
|
|
||||||
But a page's title has to be descriptive on its own while the menu is a hierarchy.
|
|
||||||
We've added the `menuTitle` parameter for that purpose:
|
|
||||||
|
|
||||||
For example (for a page named `content/install/linux.md`):
|
|
||||||
|
|
||||||
```toml
|
|
||||||
+++
|
|
||||||
title = "Install on Linux"
|
|
||||||
menuTitle = "Linux"
|
|
||||||
+++
|
|
||||||
```
|
|
||||||
|
|
||||||
## Homepage
|
|
||||||
|
|
||||||
To configure your home page, you basically have three choices:
|
|
||||||
|
|
||||||
1. Create an `_index.md` document in `content` folder and fill the file with *Markdown content*
|
|
||||||
2. Create an `index.html` file in the `static` folder and fill the file with *HTML content*
|
|
||||||
3. Configure your server to automatically redirect home page to one your documentation page
|
|
||||||
@@ -1,146 +0,0 @@
|
|||||||
---
|
|
||||||
date: 2016-04-09T16:50:16+02:00
|
|
||||||
title: Organisation des pages
|
|
||||||
weight: 5
|
|
||||||
---
|
|
||||||
|
|
||||||
Dans **Hugo**, les pages sont le coeur de votre site. Une fois configurées, les pages sont la valeur ajoutée de votre site de documentation.
|
|
||||||
|
|
||||||
## Dossiers
|
|
||||||
|
|
||||||
Organisez votre site comment n'importe quel autre [projet Hugo](https://gohugo.io/content/organization/). Typiquement, vous allez avoir un dossier *content* avec vos pages.
|
|
||||||
|
|
||||||
content
|
|
||||||
├── niveau-un
|
|
||||||
│ ├── niveau-deux
|
|
||||||
│ │ ├── niveau-trois
|
|
||||||
│ │ │ ├── niveau-quatre
|
|
||||||
│ │ │ │ ├── _index.md <-- /niveau-un/niveau-deux/niveau-trois/niveau-quatre
|
|
||||||
│ │ │ │ ├── page-4-a.md <-- /niveau-un/niveau-deux/niveau-trois/niveau-quatre/page-4-a
|
|
||||||
│ │ │ │ ├── page-4-b.md <-- /niveau-un/niveau-deux/niveau-trois/niveau-quatre/page-4-b
|
|
||||||
│ │ │ │ └── page-4-c.md <-- /niveau-un/niveau-deux/niveau-trois/niveau-quatre/page-4-c
|
|
||||||
│ │ │ ├── _index.md <-- /niveau-un/niveau-deux/niveau-trois
|
|
||||||
│ │ │ ├── page-3-a.md <-- /niveau-un/niveau-deux/niveau-trois/page-3-a
|
|
||||||
│ │ │ ├── page-3-b.md <-- /niveau-un/niveau-deux/niveau-trois/page-3-b
|
|
||||||
│ │ │ └── page-3-c.md <-- /niveau-un/niveau-deux/niveau-trois/page-3-c
|
|
||||||
│ │ ├── _index.md <-- /niveau-un/niveau-deux
|
|
||||||
│ │ ├── page-2-a.md <-- /niveau-un/niveau-deux/page-2-a
|
|
||||||
│ │ ├── page-2-b.md <-- /niveau-un/niveau-deux/page-2-b
|
|
||||||
│ │ └── page-2-c.md <-- /niveau-un/niveau-deux/page-2-c
|
|
||||||
│ ├── _index.md <-- /niveau-un
|
|
||||||
│ ├── page-1-a.md <-- /niveau-un/page-1-a
|
|
||||||
│ ├── page-1-b.md <-- /niveau-un/page-1-b
|
|
||||||
│ └── page-1-c.md <-- /niveau-un/page-1-c
|
|
||||||
├── _index.md <-- /
|
|
||||||
└── premiere-page.md <-- /premiere-page
|
|
||||||
|
|
||||||
{{% notice note %}}
|
|
||||||
Le fichier `_index.md` est obligatoire dans chaque dossier, c'est en quelques rotes votre page d'accueil pour le dossier.
|
|
||||||
{{% /notice %}}
|
|
||||||
|
|
||||||
## Types
|
|
||||||
|
|
||||||
**Hugo-theme-learn** définit deux types de pages. *Défaut* et *Chapitre*. Les deux sont utilisables à n'importe quel niveau du site, la seule différence est dans l'affichage.
|
|
||||||
|
|
||||||
Un **Chapitre** affiche une page vouée à être une introduction pour un ensemble de pages filles. Habituellement, il va seulement contenir un titre et un résumé de la section.
|
|
||||||
Vous pouvez définir n'importe quel contenu HTML comme préfixe de l'entrée du menu. Dans l'exemple ci-dessous, c'est juste un nombre mais vous pourriez utiliser une [icône](https://fortawesome.github.io/Font-Awesome/).
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
```markdown
|
|
||||||
+++
|
|
||||||
title = "Démarrage"
|
|
||||||
weight = 5
|
|
||||||
pre = "<b>1. </b>"
|
|
||||||
chapter = true
|
|
||||||
+++
|
|
||||||
|
|
||||||
### Chapitre 1
|
|
||||||
|
|
||||||
# Démarrage
|
|
||||||
|
|
||||||
Découvrez comment utiliser ce thème Hugo et apprenez en les concepts
|
|
||||||
```
|
|
||||||
|
|
||||||
Pour dire à **Hugo-theme-learn** de considérer la page comme un chapitre, configure `chapter=true` dans le Front Matter de la page.
|
|
||||||
|
|
||||||
Une page **Défaut** est n'importe quelle autre page.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
+++
|
|
||||||
title = "Installation"
|
|
||||||
weight = 15
|
|
||||||
+++
|
|
||||||
|
|
||||||
The following steps are here to help you initialize your new website. If you don't know Hugo at all, we strongly suggest you to train by following this [great documentation for beginners](https://gohugo.io/overview/quickstart/).
|
|
||||||
|
|
||||||
## Create your project
|
|
||||||
|
|
||||||
Hugo provides a `new` command to create a new website.
|
|
||||||
|
|
||||||
```
|
|
||||||
hugo new site <new_project>
|
|
||||||
```
|
|
||||||
|
|
||||||
**Hugo-theme-learn** fournit des [archétypes]({{< relref "cont/archetypes.fr.md" >}}) pour vous aider à créer ce type de pages.
|
|
||||||
|
|
||||||
## Configuration des Front Matter
|
|
||||||
|
|
||||||
Chaque page Hugo doit définir un [Front Matter](https://gohugo.io/content/front-matter/) dans le format *yaml*, *toml* ou *json*.
|
|
||||||
|
|
||||||
**Hugo-theme-learn** utilise les paramètres suivant en plus de ceux définis par Hugo:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
+++
|
|
||||||
# Le Sommaire (table of content = toc) est activé par défaut. Modifier ce paramètre à true pour le désactiver.
|
|
||||||
# Note: Le sommaire est toujours désactivé pour les chapitres
|
|
||||||
disableToc = "false"
|
|
||||||
# Le titre de la page dans le menu sera préfixé par ce contentu HTML
|
|
||||||
pre = ""
|
|
||||||
# Le titre de la page dans le menu sera suffixé par ce contentu HTML
|
|
||||||
post = ""
|
|
||||||
# Modifier le type de la page pour changer l'affichage
|
|
||||||
chapter = false
|
|
||||||
# Cache la page du menu
|
|
||||||
hidden = false
|
|
||||||
# Nom de la personne qui a modifié la page. Quand configuré, sera affiché dans le pied de page.
|
|
||||||
LastModifierDisplayName = ""
|
|
||||||
# Email de la personne qui a modifié la page. Quand configuré, sera affiché dans le pied de page.
|
|
||||||
LastModifierEmail = ""
|
|
||||||
+++
|
|
||||||
```
|
|
||||||
|
|
||||||
### Ajouter une icône à une entrée du menu
|
|
||||||
|
|
||||||
Dans le Front Matter, ajouter un paramètre `pre` pour insérer du code HTML qui s'affichera avant le label du menu. L'exemple ci-dessous utilise l'icône de Github.
|
|
||||||
|
|
||||||
```toml
|
|
||||||
+++
|
|
||||||
title = "Repo Github"
|
|
||||||
pre = "<i class='fa fa-github'></i> "
|
|
||||||
+++
|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
### Ordonner les entrées dans le menu
|
|
||||||
|
|
||||||
Hugo permet de modifier facilement [l'ordre des menu](https://gohugo.io/content/ordering/).
|
|
||||||
|
|
||||||
La manière la plus simple est de configurer le paramètre `weight` avec un nombre.
|
|
||||||
|
|
||||||
```toml
|
|
||||||
+++
|
|
||||||
title = "Ma page"
|
|
||||||
weight = 5
|
|
||||||
+++
|
|
||||||
```
|
|
||||||
|
|
||||||
## Page d'accueil
|
|
||||||
|
|
||||||
Pour configurer votre page d'accueil, vous avez trois choix:
|
|
||||||
|
|
||||||
1. Créer une page `_index.md` dans le dossier `content` et remplissez le fichier avec du *contenu Markdown*
|
|
||||||
2. Créer une page `index.html` dans le dossier `static` et remplissez le fichier avec du *contenu HTML*
|
|
||||||
3. Configurez votre serveur pour automatiquement rediriger la page d'accueil vers l'une de vos pages.
|
|
||||||
|
Before Width: | Height: | Size: 5.7 KiB |
|
Before Width: | Height: | Size: 243 KiB |
|
Before Width: | Height: | Size: 311 KiB |
@@ -1,28 +0,0 @@
|
|||||||
---
|
|
||||||
title: Credits
|
|
||||||
disableToc: true
|
|
||||||
---
|
|
||||||
|
|
||||||
## Contributors
|
|
||||||
|
|
||||||
Thanks to them <i class="fa fa-heart"></i> for making Open Source Software a better place !
|
|
||||||
|
|
||||||
{{% ghcontributors "https://api.github.com/repos/matcornic/hugo-theme-learn/contributors?per_page=100" %}}
|
|
||||||
|
|
||||||
And a special thanks to [@vjeantet](https://github.com/vjeantet) for his work on [docdock](https://github.com/vjeantet/hugo-theme-docdock), a fork of hugo-theme-learn. v2.0.0 of this theme is inspired by his work.
|
|
||||||
|
|
||||||
## Packages and libraries
|
|
||||||
* [mermaid](https://knsv.github.io/mermaid) - generation of diagram and flowchart from text in a similar manner as markdown
|
|
||||||
* [font awesome](http://fontawesome.io/) - the iconic font and CSS framework
|
|
||||||
* [jQuery](https://jquery.com) - The Write Less, Do More, JavaScript Library
|
|
||||||
* [lunr](https://lunrjs.com) - Lunr enables you to provide a great search experience without the need for external, server-side, search services...
|
|
||||||
* [horsey](https://bevacqua.github.io/horsey/) - Progressive and customizable autocomplete component
|
|
||||||
* [clipboard.js](https://zenorocha.github.io/clipboard.js) - copy text to clipboard
|
|
||||||
* [highlight.js](https://highlightjs.org) - Javascript syntax highlighter
|
|
||||||
* [modernizr](https://modernizr.com) - A JavaScript toolkit that allows web developers to use new CSS3 and HTML5 features while maintaining a fine level of control over browsers that don't support
|
|
||||||
|
|
||||||
## Tooling
|
|
||||||
|
|
||||||
* [Netlify](https://www.netlify.com) - Continuous deployement and hosting of this documentation
|
|
||||||
* [Hugo](https://gohugo.io/)
|
|
||||||
|
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
---
|
|
||||||
title: Crédits
|
|
||||||
disableToc: true
|
|
||||||
---
|
|
||||||
|
|
||||||
## Contributeurs
|
|
||||||
|
|
||||||
Merci à eux <i class="fa fa-heart"></i> de rendre le monde Open Source meilleur !
|
|
||||||
|
|
||||||
{{% ghcontributors "https://api.github.com/repos/matcornic/hugo-theme-learn/contributors?per_page=100" %}}
|
|
||||||
|
|
||||||
Et un grand merci à [@vjeantet](https://github.com/vjeantet) pour son travail sur [docdock](https://github.com/vjeantet/hugo-theme-docdock), un fork de _hugo-theme-learn_. La v2.0.0 du thème est en grande partie inspirée de son travail.
|
|
||||||
|
|
||||||
## Packages et librairies
|
|
||||||
* [mermaid](https://knsv.github.io/mermaid) - géneration de diagrames et graphiques à partir de texte similaire à Markdown
|
|
||||||
* [font awesome](http://fontawesome.io/) - Le framework de polices iconiques
|
|
||||||
* [jQuery](https://jquery.com) - La plus connue des librairies Javascript
|
|
||||||
* [lunr](https://lunrjs.com) - Lunr fournit des fonctions de recherche sans service externe
|
|
||||||
* [horsey](https://bevacqua.github.io/horsey/) - Autocomplétion de composants (utiliser pour les suggestions de recherche)
|
|
||||||
* [clipboard.js](https://zenorocha.github.io/clipboard.js) - Copier le texte dans le presse-papier
|
|
||||||
* [highlight.js](https://highlightjs.org) - Mise en valeur de syntaxes
|
|
||||||
* [modernizr](https://modernizr.com) - Une boite à outil Javascript qui permet aux développeurs d'utiliser les dernières fonctionnalités de CSS et HTML5, même sur de vieux navigateurs.
|
|
||||||
|
|
||||||
## Outils
|
|
||||||
|
|
||||||
* [Netlify](https://www.netlify.com) - Déploiement continue et hébergement de cette documentation
|
|
||||||
* [Hugo](https://gohugo.io/)
|
|
||||||
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
date: 2016-04-09T16:50:16+02:00
|
|
||||||
title: Shortcodes
|
|
||||||
pre: "<b>3. </b>"
|
|
||||||
weight: 15
|
|
||||||
---
|
|
||||||
|
|
||||||
Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’t support well. You could use pure HTML to expand possibilities.
|
|
||||||
|
|
||||||
But this happens to be a bad idea. Everyone uses Markdown because it's pure and simple to read even non-rendered. You should avoid HTML to keep it as simple as possible.
|
|
||||||
|
|
||||||
To avoid this limitations, Hugo created [shortcodes](https://gohugo.io/extras/shortcodes/). A shortcode is a simple snippet inside a page.
|
|
||||||
|
|
||||||
**Hugo-theme-learn** provides multiple shortcodes on top of existing ones.
|
|
||||||
|
|
||||||
{{%children style="h2" description="true" %}}
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
date: 2016-04-09T16:50:16+02:00
|
|
||||||
title: Shortcodes
|
|
||||||
pre: "<b>3. </b>"
|
|
||||||
weight: 15
|
|
||||||
---
|
|
||||||
|
|
||||||
Hugo utilise Markdown pour son format simple. Cependant, il y a beaucoup de chose que Markdown ne supporte pas bien. On pourrait utiliser du HTML pur pour améliorer les capacité du Markdown.
|
|
||||||
|
|
||||||
Mais c'est probablement une mauvaise idée. Tout le monde utilise le Markdown parce que c'est pur et simple à lire même lorsqu'il est affiché en texte brut. Vous devez éviter le HTML autant que possible pour garder le contenu simple.
|
|
||||||
|
|
||||||
Cependant, pour éviter les limitations, Hugo a créé les [shortcodes](https://gohugo.io/extras/shortcodes/). Un shortcode est un bout de code (*snippet*) dans une page.
|
|
||||||
|
|
||||||
**Hugo-theme-learn** fournit de multiple shortcodes en plus de ceux existant.
|
|
||||||
|
|
||||||
{{%children style="h2" description="true" %}}
|
|
||||||
|
Before Width: | Height: | Size: 18 KiB |